/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
using Avro.IO;

namespace Avro.Generic
{
    /// <summary>
    /// Defines the interface for an object that writes data of a schema.
    /// </summary>
    /// <typeparam name="T">Type of the in-memory data representation.</typeparam>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming",
        "CA1715:Identifiers should have correct prefix", Justification = "Maintain public API")]
    public interface DatumWriter<T>
    {
        /// <summary>
        /// Schema used to write the data.
        /// </summary>
        Schema Schema { get; }

        /// <summary>
        /// Write a datum. Traverse the schema, depth first, writing each leaf value in the schema
        /// from the datum to the output.
        /// </summary>
        /// <param name="datum">Datum to write</param>
        /// <param name="encoder">Encoder to write to</param>
        void Write(T datum, Encoder encoder);
    }
}