<?php

declare(strict_types = 1);

namespace Wyomind\ElasticsearchCore\Elasticsearch\Serializers;

/**
 * Interface SerializerInterface
 *
 * @category Wyomind\Elasticsearch
 * @package  Wyomind\ElasticsearchCore\Elasticsearch\Serializers
 * @author   Zachary Tong <zach@elastic.co>
 * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache2
 * @link     http://elastic.co
 */
interface SerializerInterface
{
    /**
     * Serialize a complex data-structure into a json encoded string
     *
     * @param  mixed $data The data to encode
     * @return string
     */
    public function serialize($data): string;

    /**
     * Deserialize json encoded string into an associative array
     *
     * @param  string $data    JSON encoded string
     * @param  array  $headers Response Headers
     * @return string|array
     */
    public function deserialize(?string $data, array $headers);
}
