Show / Hide Table of Contents

Class SlimFormat

A format that writes into binary files in an efficient way using variable-length integers, strings and meta handles. Developers may derive new formats that support custom serialization of their business-related types. This may increase performance dramatically. For example, in a drawing application a new format may derive from SlimFormat to natively serialize Point and PolarPoint structs to yield faster serialization times. NFX.Serialization.Slim.SlimSlimSerializer is capable of SlimFormat-derived format injection, in which case it will automatically discover new types that are directly supported by the format.

Inheritance
System.Object
StreamerFormat
StreamerFormat<SlimReader, SlimWriter>
SlimFormat
Inherited Members
StreamerFormat<SlimReader, SlimWriter>.GetReadingStreamer(Encoding)
StreamerFormat<SlimReader, SlimWriter>.GetWritingStreamer(Encoding)
StreamerFormat<SlimReader, SlimWriter>.MakeReadingStreamer(Encoding)
StreamerFormat<SlimReader, SlimWriter>.MakeWritingStreamer(Encoding)
StreamerFormat<SlimReader, SlimWriter>.IsTypeSupported(Type)
StreamerFormat<SlimReader, SlimWriter>.IsRefTypeSupported(Type)
StreamerFormat<SlimReader, SlimWriter>.GetReadMethodForType(Type)
StreamerFormat<SlimReader, SlimWriter>.GetReadMethodForRefType(Type)
StreamerFormat<SlimReader, SlimWriter>.GetWriteMethodForType(Type)
StreamerFormat<SlimReader, SlimWriter>.GetWriteMethodForRefType(Type)
StreamerFormat<SlimReader, SlimWriter>.GetReadActionForType(Type)
StreamerFormat<SlimReader, SlimWriter>.GetReadActionForRefType(Type)
StreamerFormat<SlimReader, SlimWriter>.GetWriteActionForType(Type)
StreamerFormat<SlimReader, SlimWriter>.GetWriteActionForRefType(Type)
StreamerFormat.GetReadingStreamer(Encoding)
StreamerFormat.GetWritingStreamer(Encoding)
StreamerFormat.IsTypeSupported(Type)
StreamerFormat.IsRefTypeSupported(Type)
StreamerFormat.GetReadMethodForType(Type)
StreamerFormat.GetReadMethodForRefType(Type)
StreamerFormat.GetWriteMethodForType(Type)
StreamerFormat.GetWriteMethodForRefType(Type)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.IO
Assembly: NFX.dll
Syntax
public class SlimFormat : StreamerFormat<SlimReader, SlimWriter>

Constructors

SlimFormat()

Declaration
protected SlimFormat()

Fields

MAX_BYTE_ARRAY_LEN

Declaration
public const int MAX_BYTE_ARRAY_LEN = 536870912
Field Value
Type Description
System.Int32

MAX_DECIMAL_ARRAY_LEN

Declaration
public const int MAX_DECIMAL_ARRAY_LEN = 41297762
Field Value
Type Description
System.Int32

MAX_DOUBLE_ARRAY_LEN

Declaration
public const int MAX_DOUBLE_ARRAY_LEN = 67108864
Field Value
Type Description
System.Int32

MAX_FLOAT_ARRAY_LEN

Declaration
public const int MAX_FLOAT_ARRAY_LEN = 134217728
Field Value
Type Description
System.Int32

MAX_INT_ARRAY_LEN

Declaration
public const int MAX_INT_ARRAY_LEN = 134217728
Field Value
Type Description
System.Int32

MAX_LONG_ARRAY_LEN

Declaration
public const int MAX_LONG_ARRAY_LEN = 67108864
Field Value
Type Description
System.Int32

MAX_STR_LEN

Declaration
public const int MAX_STR_LEN = 32752
Field Value
Type Description
System.Int32

MAX_STRING_ARRAY_CNT

Declaration
public const int MAX_STRING_ARRAY_CNT = 11184810
Field Value
Type Description
System.Int32

STR_BUF_SZ

Declaration
public const int STR_BUF_SZ = 98304
Field Value
Type Description
System.Int32

Properties

Instance

Returns a singleton format instance

Declaration
public static SlimFormat Instance { get; }
Property Value
Type Description
SlimFormat

ReaderType

Declaration
public override Type ReaderType { get; }
Property Value
Type Description
System.Type
Overrides
StreamerFormat.ReaderType

WriterType

Declaration
public override Type WriterType { get; }
Property Value
Type Description
System.Type
Overrides
StreamerFormat.WriterType

Methods

MakeReadingStreamer(Encoding)

Declaration
public override SlimReader MakeReadingStreamer(Encoding encoding = null)
Parameters
Type Name Description
System.Text.Encoding encoding
Returns
Type Description
SlimReader
Overrides
NFX.IO.StreamerFormat<NFX.IO.SlimReader, NFX.IO.SlimWriter>.MakeReadingStreamer(System.Text.Encoding)

MakeWritingStreamer(Encoding)

Declaration
public override SlimWriter MakeWritingStreamer(Encoding encoding = null)
Parameters
Type Name Description
System.Text.Encoding encoding
Returns
Type Description
SlimWriter
Overrides
NFX.IO.StreamerFormat<NFX.IO.SlimReader, NFX.IO.SlimWriter>.MakeWritingStreamer(System.Text.Encoding)

Extension Methods

MiscUtils.NonNull<T>(T, Func<Exception>, String)
ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX