FsPicklerSerializer

Namespace: MBrace.FsPickler
Attributes:
[<AbstractClass>]

An abstract class containg the basic serialization API.

Constructors

Constructor	Description
`new(...)` Signature: (formatProvider:IPickleFormatProvider * typeConverter:ITypeNameConverter option * picklerResolver:IPicklerResolver option) -> FsPicklerSerializer	CompiledName: `.ctor`

Instance members

Instance member	Description
`x.ComputeHash(value, hashFactory)` Signature: (value:'T * hashFactory:IHashStreamFactory option) -> HashResult Type parameters: 'T	Compute size and hashcode for given input.
`x.ComputeSize(value, pickler)` Signature: (value:'T * pickler:Pickler<'T> option) -> int64 Type parameters: 'T	Compute size in bytes for given input.
`x.CreateObjectSizeCounter(...)` Signature: (encoding:Encoding option * resetInterval:int64 option) -> ObjectSizeCounter	Creates a state object used for computing accumulated sizes for multiple objects.
`x.Deserialize(...)` Signature: (stream:Stream * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> 'T Type parameters: 'T	Deserialize value of given type from the underlying stream.
`x.DeserializeSequence(...)` Signature: (stream:Stream * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> seq<'T> Type parameters: 'T	Lazily deserialize a sequence of objects from the underlying stream.
`x.DeserializeSequenceUntyped(...)` Signature: (stream:Stream * pickler:Pickler * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> IEnumerable	Lazily deserialize an untyped sequence of objects from the underlying stream.
`x.DeserializeSifted(...)` Signature: (stream:Stream * sifted:(int64 * obj) [] * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> 'T Type parameters: 'T	Deserializes a sifted value from stream, filling in sifted holes from the serialized using supplied objects.
`x.DeserializeUntyped(...)` Signature: (stream:Stream * pickler:Pickler * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> obj	Deserialize untyped object from the underlying stream with provided pickler.
`x.DisableAssemblyLoading()` Signature: unit -> bool	Declares that FsPickler should make no attempt of its own to load Assemblies that are specified in the serialization format. Will result in a deserialization exception if required assembly is missing from the current AppDomain. Defaults to false. CompiledName: `set_DisableAssemblyLoading`
`x.DisableAssemblyLoading()` Signature: unit -> unit	Declares that FsPickler should make no attempt of its own to load Assemblies that are specified in the serialization format. Will result in a deserialization exception if required assembly is missing from the current AppDomain. Defaults to false. CompiledName: `get_DisableAssemblyLoading`
`x.DisableSubtypeResolution()` Signature: unit -> bool	Declares that dynamic subtype resolution should be disabled during serialization. This explicitly prohibits serialization/deserialization of any objects whose type is specified in the serialization payload. Examples of such types are System.Object, F# functions and delegates. Defaults to false. CompiledName: `set_DisableSubtypeResolution`
`x.DisableSubtypeResolution()` Signature: unit -> unit	Declares that dynamic subtype resolution should be disabled during serialization. This explicitly prohibits serialization/deserialization of any objects whose type is specified in the serialization payload. Examples of such types are System.Object, F# functions and delegates. Defaults to false. CompiledName: `get_DisableSubtypeResolution`
`x.Pickle(...)` Signature: (value:'T * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option) -> byte [] Type parameters: 'T	Pickles given value to byte array.
`x.PickleFormat` Signature: string	Description of the pickle format used by the serializer. CompiledName: `get_PickleFormat`
`x.PickleSifted(...)` Signature: (value:'T * sifter:IObjectSifter * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option) -> byte [] * (int64 * obj) [] Type parameters: 'T	Pickles value to bytes, excluding objects mandated by the provided IObjectSifter instance. Values excluded from serialization will be returned tagged by their ids. Sifted objects will have to be provided on deserialization along with their accompanying id's.
`x.PickleUntyped(...)` Signature: (value:obj * pickler:Pickler * streamingContext:StreamingContext option * encoding:Encoding option) -> byte []	Pickles given value to byte array.
`x.Resolver` Signature: IPicklerResolver	CompiledName: `get_Resolver`
`x.Serialize(...)` Signature: (stream:Stream * value:'T * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> unit Type parameters: 'T	Serialize value to the underlying stream.
`x.SerializeSequence(...)` Signature: (stream:Stream * sequence:seq<'T> * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> int Type parameters: 'T	Serialize a sequence of objects to the underlying stream.
`x.SerializeSequenceUntyped(...)` Signature: (stream:Stream * sequence:IEnumerable * pickler:Pickler * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> int	Serialize an untyped sequence of objects to the underlying stream.
`x.SerializeSifted(...)` Signature: (stream:Stream * value:'T * sifter:IObjectSifter * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> (int64 * obj) [] Type parameters: 'T	Serializes a value to stream, excluding objects mandated by the provided IObjectSifter instance. Values excluded from serialization will be returned tagged by their ids. Sifted objects will have to be provided on deserialization along with their accompanying id's.
`x.SerializeUntyped(...)` Signature: (stream:Stream * value:obj * pickler:Pickler * streamingContext:StreamingContext option * encoding:Encoding option * leaveOpen:bool option) -> unit	Serialize untyped object to the underlying stream with provided pickler.
`x.UnPickle(...)` Signature: (data:byte [] * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option) -> 'T Type parameters: 'T	Unpickles value using given pickler.
`x.UnPickleSifted(...)` Signature: (pickle:byte [] * sifted:(int64 * obj) [] * pickler:Pickler<'T> option * streamingContext:StreamingContext option * encoding:Encoding option) -> 'T Type parameters: 'T	Unpickles a sifted value, filling in sifted holes from the serialized using supplied objects.
`x.UnPickleUntyped(...)` Signature: (pickle:byte [] * pickler:Pickler * streamingContext:StreamingContext option * encoding:Encoding option) -> obj	Unpickle value to given type.