src/Proton/Codec/Encoders/IUtf8Encoder.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.
 */

using Apache.Qpid.Proton.Buffer;

namespace Apache.Qpid.Proton.Codec.Encoders
{
   /// <summary>
   /// Interface for an external UTF8 Encoder that can be supplied by a client
   /// which implements custom encoding logic optimized for the application using
   /// the Codec.
   /// </summary>
   public interface IUtf8Encoder
   {
      /// <summary>
      /// Encodes the given sequence of characters in UTF8 to the given buffer.
      /// </summary>
      /// <param name="buffer">The buffer where the encoding will be written</param>
      /// <param name="sequence">The string whose characters will be encoded</param>
      /// <returns>A reference to the encoding buffer for chaining</returns>
      IProtonBuffer EncodeUTF8(IProtonBuffer buffer, string sequence);
   }
}