clients/csharp/src/Kafka/Kafka.Client/Serialization/IEncoder.cs

/**
 * 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
 *
 *    http://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 Kafka.Client.Serialization
{
    using Kafka.Client.Messages;

    /// <summary>
    /// User-defined serializer to <see cref="Message" /> format
    /// </summary>
    /// <typeparam name="TData">
    /// Type od data
    /// </typeparam>
    public interface IEncoder<TData>
    {
        /// <summary>
        /// Serializes given data to <see cref="Message" /> format
        /// </summary>
        /// <param name="data">
        /// The data to serialize.
        /// </param>
        /// <returns>
        /// Serialized data
        /// </returns>
        Message ToMessage(TData data);
    }
}