Search Results for

    Show / Hide Table of Contents

    Class ConnectionSettingsAwareSerializerBase

    Inheritance
    object
    ConnectionSettingsAwareSerializerBase
    JsonNetSerializer
    Implements
    IOpenSearchSerializer
    IPropertyMappingProvider
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client.JsonNetSerializer
    Assembly: OpenSearch.Client.JsonNetSerializer.dll
    Syntax
    public abstract class ConnectionSettingsAwareSerializerBase : IOpenSearchSerializer, IPropertyMappingProvider

    Constructors

    | Edit this page View Source

    ConnectionSettingsAwareSerializerBase(IOpenSearchSerializer, IConnectionSettingsValues)

    Declaration
    protected ConnectionSettingsAwareSerializerBase(IOpenSearchSerializer builtinSerializer, IConnectionSettingsValues connectionSettings)
    Parameters
    Type Name Description
    IOpenSearchSerializer builtinSerializer
    IConnectionSettingsValues connectionSettings

    Fields

    | Edit this page View Source

    Properties

    Declaration
    protected readonly ConcurrentDictionary<string, IPropertyMapping> Properties
    Field Value
    Type Description
    ConcurrentDictionary<string, IPropertyMapping>

    Properties

    | Edit this page View Source

    BufferSize

    Declaration
    protected virtual int BufferSize { get; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    BuiltinSerializer

    Declaration
    protected IOpenSearchSerializer BuiltinSerializer { get; }
    Property Value
    Type Description
    IOpenSearchSerializer
    | Edit this page View Source

    ConnectionSettings

    Declaration
    protected IConnectionSettingsValues ConnectionSettings { get; }
    Property Value
    Type Description
    IConnectionSettingsValues
    | Edit this page View Source

    ContractJsonConverters

    Declaration
    protected IEnumerable<JsonConverter> ContractJsonConverters { get; }
    Property Value
    Type Description
    IEnumerable<JsonConverter>
    | Edit this page View Source

    JsonSerializerSettingsFactory

    Declaration
    protected Func<JsonSerializerSettings> JsonSerializerSettingsFactory { get; }
    Property Value
    Type Description
    Func<JsonSerializerSettings>
    | Edit this page View Source

    ModifyContractResolverCallback

    Declaration
    protected Action<ConnectionSettingsAwareContractResolver> ModifyContractResolverCallback { get; }
    Property Value
    Type Description
    Action<ConnectionSettingsAwareContractResolver>

    Methods

    | Edit this page View Source

    CreateContractResolver()

    Declaration
    protected virtual ConnectionSettingsAwareContractResolver CreateContractResolver()
    Returns
    Type Description
    ConnectionSettingsAwareContractResolver
    | Edit this page View Source

    CreateJsonConverters()

    Declaration
    protected virtual IEnumerable<JsonConverter> CreateJsonConverters()
    Returns
    Type Description
    IEnumerable<JsonConverter>
    | Edit this page View Source

    CreateJsonSerializerSettings()

    Declaration
    protected virtual JsonSerializerSettings CreateJsonSerializerSettings()
    Returns
    Type Description
    JsonSerializerSettings
    | Edit this page View Source

    CreatePropertyMapping(MemberInfo)

    Creates an IPropertyMapping for a MemberInfo

    Declaration
    public IPropertyMapping CreatePropertyMapping(MemberInfo memberInfo)
    Parameters
    Type Name Description
    MemberInfo memberInfo
    Returns
    Type Description
    IPropertyMapping
    | Edit this page View Source

    Deserialize(Type, Stream)

    Deserialize stream to an instance of type

    Declaration
    public object Deserialize(Type type, Stream stream)
    Parameters
    Type Name Description
    Type type
    Stream stream
    Returns
    Type Description
    object
    | Edit this page View Source

    DeserializeAsync(Type, Stream, CancellationToken)

    Deserialize stream to an instance of type

    Declaration
    public virtual Task<object> DeserializeAsync(Type type, Stream stream, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Type type
    Stream stream
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<object>
    | Edit this page View Source

    DeserializeAsync<T>(Stream, CancellationToken)

    Deserialize stream to an instance of T

    Declaration
    public virtual Task<T> DeserializeAsync<T>(Stream stream, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Stream stream
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<T>
    Type Parameters
    Name Description
    T
    | Edit this page View Source

    Deserialize<T>(Stream)

    Deserialize stream to an instance of T

    Declaration
    public T Deserialize<T>(Stream stream)
    Parameters
    Type Name Description
    Stream stream
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T
    | Edit this page View Source

    ModifyContractResolver(ConnectionSettingsAwareContractResolver)

    Declaration
    protected virtual void ModifyContractResolver(ConnectionSettingsAwareContractResolver resolver)
    Parameters
    Type Name Description
    ConnectionSettingsAwareContractResolver resolver
    | Edit this page View Source

    SerializeAsync<T>(T, Stream, SerializationFormatting, CancellationToken)

    Serialize an instance of T to stream using formatting.

    Declaration
    public Task SerializeAsync<T>(T data, Stream stream, SerializationFormatting formatting = SerializationFormatting.None, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    T data

    The instance of T that we want to serialize

    Stream stream

    The stream to serialize to

    SerializationFormatting formatting

    Formatting hint, note no all implementations of IOpenSearchSerializer are able to satisfy this hint.

    CancellationToken cancellationToken
    Returns
    Type Description
    Task
    Type Parameters
    Name Description
    T
    | Edit this page View Source

    Serialize<T>(T, Stream, SerializationFormatting)

    Serialize an instance of T to stream using formatting.

    Declaration
    public void Serialize<T>(T data, Stream stream, SerializationFormatting formatting = SerializationFormatting.None)
    Parameters
    Type Name Description
    T data

    The instance of T that we want to serialize

    Stream stream

    The stream to serialize to

    SerializationFormatting formatting

    Formatting hint, note no all implementations of IOpenSearchSerializer are able to satisfy this hint.

    Type Parameters
    Name Description
    T

    Implements

    IOpenSearchSerializer
    IPropertyMappingProvider

    Extension Methods

    OpenSearchSerializerExtensions.SerializeToBytes<T>(IOpenSearchSerializer, T, IMemoryStreamFactory, SerializationFormatting)
    OpenSearchSerializerExtensions.SerializeToBytes<T>(IOpenSearchSerializer, T, SerializationFormatting)
    OpenSearchSerializerExtensions.SerializeToString<T>(IOpenSearchSerializer, T, IMemoryStreamFactory, SerializationFormatting)
    OpenSearchSerializerExtensions.SerializeToString<T>(IOpenSearchSerializer, T, SerializationFormatting)
    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • ConnectionSettingsAwareSerializerBase(IOpenSearchSerializer, IConnectionSettingsValues)
    • Fields
      • Properties
    • Properties
      • BufferSize
      • BuiltinSerializer
      • ConnectionSettings
      • ContractJsonConverters
      • JsonSerializerSettingsFactory
      • ModifyContractResolverCallback
    • Methods
      • CreateContractResolver()
      • CreateJsonConverters()
      • CreateJsonSerializerSettings()
      • CreatePropertyMapping(MemberInfo)
      • Deserialize(Type, Stream)
      • DeserializeAsync(Type, Stream, CancellationToken)
      • DeserializeAsync<T>(Stream, CancellationToken)
      • Deserialize<T>(Stream)
      • ModifyContractResolver(ConnectionSettingsAwareContractResolver)
      • SerializeAsync<T>(T, Stream, SerializationFormatting, CancellationToken)
      • Serialize<T>(T, Stream, SerializationFormatting)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX