<?php
/*
 * Copyright 2023-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace MongoDB\Codec;

use MongoDB\Exception\UnsupportedValueException;

/**
 * @psalm-template BSONType
 * @psalm-template NativeType
 */
interface Encoder
{
    /**
     * Checks if the encoder supports a given value.
     *
     * @psalm-assert-if-true NativeType $value
     */
    public function canEncode(mixed $value): bool;

    /**
     * Encodes a given value. If the encoder does not support the value, it
     * should throw an exception.
     *
     * @psalm-param NativeType $value
     * @psalm-return BSONType
     * @throws UnsupportedValueException if the encoder does not support the value
     */
    public function encode(mixed $value): mixed;

    /**
     * Encodes a given value if supported, otherwise returns the value as-is.
     *
     * The EncodeIfSupported trait provides a default implementation of this
     * method.
     *
     * @psalm-return ($value is NativeType ? BSONType : $value)
     */
    public function encodeIfSupported(mixed $value): mixed;
}
