FsPickler


FsPickler

Namespace: MBrace.FsPickler

FsPickler static methods.

Static members

Static memberDescription
FsPickler.Clone(...)
Signature: (value:'T * pickler:Pickler<'T> option * streamingContext:StreamingContext option) -> 'T
Type parameters: 'T

Performs an in-memory, deep cloning of provided serializable object graph. Cloning is performed on a node-to-node basis and does not make use of intermediate serialization buffers.

FsPickler.ComputeHash(...)
Signature: (value:'T * hashFactory:IHashStreamFactory option) -> HashResult
Type parameters: 'T

Compute size and hashcode for given input.

FsPickler.ComputeSize(value, pickler)
Signature: (value:'T * pickler:Pickler<'T> option) -> int64
Type parameters: 'T

Compute size in bytes for given input.

FsPickler.CreateBinarySerializer(...)
Signature: (forceLittleEndian:bool option * typeConverter:ITypeNameConverter option * picklerResolver:IPicklerResolver option) -> BinarySerializer

Create a new FsPickler serializer instance that uses the built-in binary format.

FsPickler.CreateObjectSizeCounter(...)
Signature: (encoding:Encoding option * resetInterval:int64 option) -> ObjectSizeCounter

Creates a state object used for computing accumulated sizes for multiple objects.

FsPickler.CreateXmlSerializer(...)
Signature: (typeConverter:ITypeNameConverter option * indent:bool option * picklerResolver:IPicklerResolver option) -> XmlSerializer

Create a new FsPickler serializer instance that uses the XML format.

FsPickler.EnsureSerializable(...)
Signature: (graph:'T * failOnCloneableOnlyTypes:bool option) -> unit
Type parameters: 'T

Traverses the object graph, completing if serializable or raising a serialization exception if not.

FsPickler.GatherObjectsInGraph(graph)
Signature: graph:obj -> obj []

Use FsPickler to traverse the object graph, gathering object instances as it goes.

FsPickler.GatherTypesInObjectGraph(...)
Signature: graph:obj -> Type []

Uses FsPickler to traverse the object graph, gathering types of objects as it goes.

FsPickler.GeneratePickler(t)
Signature: t:Type -> Pickler

Auto generates a pickler for given type

FsPickler.GeneratePickler()
Signature: unit -> Pickler<'T>
Type parameters: 'T

Auto generates a pickler for given type variable

FsPickler.IsSerializableType(t)
Signature: t:Type -> bool

Decides if given type is serializable by FsPickler

FsPickler.IsSerializableType()
Signature: unit -> bool
Type parameters: 'T

Decides if given type is serializable by FsPickler

FsPickler.IsSerializableValue(...)
Signature: (graph:'T * failOnCloneableOnlyTypes:bool option) -> bool
Type parameters: 'T

Decides if given value is serializable object graph without performing an actual serialization.

FsPickler.Sift(...)
Signature: (value:'T * sifter:(obj -> bool) * pickler:Pickler<'T> option * streamingContext:StreamingContext option) -> Sifted<'T> * (int64 * obj) []
Type parameters: 'T

Creates a clone of the provided object graph, sifting objects from the graph as specified by the provided sifter implementation. Only reference types can be sifted from a graph.

FsPickler.Sift(...)
Signature: (value:'T * sifter:IObjectSifter * pickler:Pickler<'T> option * streamingContext:StreamingContext option) -> Sifted<'T> * (int64 * obj) []
Type parameters: 'T

Creates a clone of the provided object graph, sifting objects from the graph as specified by the provided sifter implementation. Only reference types can be sifted from a graph.

FsPickler.UnSift(...)
Signature: (sifted:Sifted<'T> * values:(int64 * obj) [] * pickler:Pickler<'T> option * streamingContext:StreamingContext option) -> 'T
Type parameters: 'T

Unsifts a provided object graph with given values.

FsPickler.VisitObject(...)
Signature: (visitor:IObjectVisitor * graph:'T * pickler:Pickler<'T> option * streamingContext:StreamingContext option * visitOrder:VisitOrder option) -> unit
Type parameters: 'T

Visits all reference types that appear in the given object graph.

Fork me on GitHub