FlatSharp.Runtime

Marks a class, struct, or enum as "external", a type that is defined in another location and not generated by FlatSharp. This is a "transient" attribute only used with the FlatSharp compiler. If you see this in generated code, something has gone wrong!

Assert that the FlatSharp.Runtime assembly version matches the FlatSharp.Compiler assembly version.

Asserts that the type T has the expected size.

Asserts that the system is a LE architecture. This method is inlined because the condition can be evaluated at JIT time.

Validates that the size of TElement is a multiple of the alignment. This ensures that items can be laid out sequentially with no gaps between them. Inlining this method should allow this check to be elided as the alignment is a constant from the callsite.

An interface implemented on buffer-backed Flatbuffer vectors. This interface is internal to FlatSharp and exposes some functionality to assist with binary searching.

Gets the input buffer.

Gets the raw item size of each element in the vector.

The number of items.

Gets the base offset of the vector.

Returns the absolute position in the Input Buffer of the given index in the vector.

Gets the item at the given index.

Wrapper struct to pass arguments into Parse methods on .

An interface implemented dynamically by FlatSharp for reading and writing data from a buffer.

Writes the given item to the buffer using the given spanwriter.

The span writer. The span to write to. The object to serialize. The serialization context.

Computes the maximum size necessary to serialize the given instance of .

Parses the given buffer as an instance of from the given offset.

Extensions for input buffers.

Reads a bool.

Reads a string at the given offset.

Reads a string from the given uoffset.

Reads the given uoffset.

Validates a vtable and reads the initial bytes of a vtable.

Reads a sequence of TElement items from the buffer at the given offset using the equivalent of reinterpret_cast.

A class that reads FlatBuffer scalars.

Extension methods that apply to all implementations.

Writes the given string.

Writes the string to the buffer, returning the absolute offset of the string.

An analog of IComparer for Spans. The implementation performs comparison consistent with the type the span represents.

Compares the two spans.

A context object for a FlatBuffer serialize operation. The context is responsible for allocating space in the buffer and managing the latest offset.

A delegate to invoke after the serialization process has completed. Used for sorting vectors.

Initializes a new serialization context.

The maximum offset within the buffer.

The shared string writer used for this serialization operation.

Resets the context.

Invokes any post-serialize actions.

Allocate a vector and return the index. Does not populate any details of the vector.

Allocates a block of memory. Returns the offset.

Collection of methods that help to serialize objects. It's kind of a hodge-podge, but mostly focuses on getting the size of things when serializing and data alignment.

Encoding used for strings.

Value of true as a byte.

Value of false as a byte.

Gets the maximum padding for the given alignment. This method seems simple, but is inlined and is useful for generating more comprehensible IL.

Applies a bitwise OR to the operands.

Returns the number of padding bytes to be added to the given offset to acheive the given alignment.

Throws an InvalidDataException if the given item is null.

Add generic constraint to catch errors calling this for value types.

Throws if the depth limit is less than 0.

Helper methods for dealing with sorted vectors. This class provides functionality for both sorting vectors and binary searching through them.

Sorts the given flatbuffer vector. This method, used incorrectly, is a fantastic way to corrupt your buffer.

This method assumes that all vector members are tables, and each table has a defined key. Our vector looks like this: [length] [ uoffset to first table ] [ uoffset 2 ] ... [ uoffset N ] Prior to sorting, we iterate through the vector and populate an array with tuples of (absolute key offset, key length, absolute table offset). Then, we sort that array. This saves us from having to follow unnecessary indirections from vector -> table -> vtable -> key. After we sort our array of tuples, we go back and overwrite the vectors with the updated uoffsets, which need to be adjusted relative to the new position within the vector. Furthermore, this method is left without checked multiply operations since this is a post-serialize action, which means the input has already been sanitized since FlatSharp wrote it.

A partial introsort implementation, inspired by the Array.Sort implemenation from the CoreCLR. Due to the amount of indirection in FlatBuffers, it's not possible to use the built-in sorting algorithms, so we do the next best thing. Note that this is not a true IntroSort, since we omit the HeapSort component.

For the given index in a vector, follow the indirection to return a tuple representing the key start offset, the key length, and the table offset. It's advantageous to return the tuple here since we can store that in a span.

Left as unchecked since this is a sort operation (not a search).

Implements string comparison for flatbuffers.

Based on the FlatBuffer comparison here: https://github.com/google/flatbuffers/blob/3a70e0b30890ca265a33f099912762eb51ac505f/net/FlatBuffers/Table.cs

Singleton access.

A context containing information about the table field.

For debug purposes. Contains the full name of the associated table property.

Indicates if this context enables shared strings.

Indicates if this field is flagged as writethrough-enabled.

Helper methods for deep-cloning vectors.

An implementation of IIndexedVector for use after deserializing an object. This class is not intended to be used directly -- only from code generated by FlatSharp.

Always readonly.

Gets the count of items.

No-op. We are already immutable.

An implementation that loads data progressively.

An indexer for getting values by their keys.

Indicates if this IndexedVector is read only.

Gets the count of items.

Freezes an Indexed vector, preventing further modifications.

Returns true if the vector contains the given key.

Tries to get the given value from the backing dictionary.

Gets the dictionary's enumerator.

Gets a non-generic enumerator.

Adds or replaces the item with the given key to the indexed vector.

Attempts to add the value to the indexed vector, if a key does not already exist.

Gets the key from the given value.

An indexer for getting values by their keys.

Indicates if this IndexedVector is read only.

Gets the count of items.

Freezes an Indexed vector, preventing further modifications.

Returns true if the vector contains the given key.

Tries to get the given value from the backing dictionary.

Gets the dictionary's enumerator.

Gets a non-generic enumerator.

Adds or replaces the item with the given key to the indexed vector.

Attempts to add the value to the indexed vector, if a key does not already exist.

A table that may be sorted in a vector.

Common methods for all vectors.

Represents a vtable for a table with up to 4 fields.

A generic/safe initialize method for BE archtectures.

An optimized load mmethod for LE architectures.

Represents a vtable for a table with up to 8 fields.

A generic/safe initialize method for BE archtectures.

An optimized load mmethod for LE architectures.

Represents a vtable for an arbitrary table.

Marks an enum as being elible for FlatSharp serialization.

Usage of enums comes with two main caveats: the enum may only be extended (ie, values cannot be recycled), and the underlying type may not be changed.

Initializes a new instance of the FlatBufferEnumAttribute class.

The declared underlying type of the enum. This must match the enum's actual underlying type.

The declared underlying type. This is a saftey check to prevent unintended binary breaks.

Defines a member of a FlatBuffer struct or table.

Initializes a new FlatBufferItemAttribute.

The field index within the struct or table.

The index within the struct or table.

For tables, indicates if this field is deprecated. Deprecated fields are not written or read.

Indicates that the given vector property is to be serialized sorted by the key property of the vector type.

Indicates that this field is the key for the table. Keys are used when sorting inside a vector. Only valid on a table.

For table items, gets or sets the default value. The type of the object must match the type of the property.

When set, indicates that this item should always be written to tables, even if it matches the default value. An exception is raised if this is set in a context where Force-Writing is not allowed.

When set, indicates that this property is write-through to the underlying vector. Only supported on scalars, structs, and enums in addition to vectors of those types.

When set, indicates that the field is required. Only applies to non-scalar fields on tables.

Indicates if strings within this vector or item should be shared.

Describes kinds of metadata.

A custom get/set accessor for a flatbuffer field.

A FBS attribute

Defines a member of a FlatBuffer struct or table.

Initializes a new FlatBufferMetadataAttribute.

The key.

The value.

The kind of metadata.

Indicates how FlatSharp should use MemoryMarshal.Cast when interacting with this struct. When Memory Marshalling is enabled, FlatSharp will opportunistically serialize and deserialize a value-type struct with a call to .

Never. Always use field by field copies.

Flatsharp will choose when to enable memory marshalling. This can change from release to release.

Memory marshalling is enabled when serializing only.

Memory marshalling is enabled when parsing only.

Memory marshalling is enabled for both serializing and parsing.

Marks a class as being a FlatBuffer struct.

Enables reading and writing value structs with calls to MemoryMarshal.Cast.

Marks a class as being a FlatBuffer table.

Specifies the file identifier for serialized tables. Must be precisely 4 ASCII characters.

Indicates that a serializer should be built for the given table.

Raised in serialization when the provided buffer was too small.

The maximum amount of size needed for this message.

A context that FlatSharp-deserialized classes will pass to their parent object on construction, if the parent object defines a constructor that accepts this object.

Initializes a new FlatSharpConstructorContext with the given deserialization option.

The deserialization options used to create the current subclass.

Defines FlatSharp deserialization options.

Full Lazy parsing. Deserialized objects are immutable.

Each object in the deserialized payload is read from the underlying buffer at most once. Reads are done on demand and cached. The returned object is immutable.

The entire object graph is traversed and the deserialized objects do not reference the input buffer. Deserialized objects are immutable.

The entire object graph is traversed and the deserialized objects do not reference the input buffer. Deserialized objects are mutable.

Default options.

An implementation of that wraps a .

An interface applied to objects deserialized by FlatSharp. FlatSharp implements this interface on deserialized objects. It should not be implemented externally.

The actual type of the table or struct. This is generally the base class.

The context of the deserialized object.

Gets the input buffer instance used to lazily read this object. This buffer will not have a value when the derserialization mode is or .

Indcates that this deserialized object is immutable or has semantics where all changes are written back to the underlying buffer. This can allow serialize operations to be implemented as memcopy instead of a full serialize flow.

An object that can supply an instance that can serialize and parse it.

Gets a instance that can serialize this object.

An object that can supply an instance that can serialize and parse it.

Gets a instance that can serialize instances of .

An implementation of for managed arrays.

An implementation of for array segments.

Defines a buffer that FlatSharp can parse from. Implementations will be fastest when using a struct.

Indicates if this instance is read only.

Indicates if this instance represents pinned (non-movable) memory.

Gets the length of this input buffer.

Reads the byte at the given offset.

Reads the sbyte at the given offset.

Reads the ushort at the given offset.

Reads the short at the given offset.

Reads the uint at the given offset.

Reads the int at the given offset.

Reads the ulong at the given offset.

Reads the long at the given offset.

Reads the float at the given offset.

Reads the double at the given offset.

Reads the string of the given length at the given offset with the given encoding.

Gets a read only span covering the entire input buffer.

Gets a read only memory covering the entire input buffer.

Gets a span covering the entire input buffer.

Gets a memory covering the entire input buffer.

Defines an interface capable of delay writing strings to a SpanWriter. Can be used to reduce the size of a FlatBuffer binary payload when there are many duplicate strings. Implementations of ISharedStringWriter need not be threadsafe.

Indicates that there are pending items to be flushed in this shared string writer. Each call to WriteSharedString is expected to set this to true, while each call to FlushWrites and Reset is expected to set this to false.

Invoked before a new write operation begins.

Writes the given string to the span.

The spanwriter. The span. The location in the buffer of the uoffset to the string. The string to write. The serialization context.

Flushes any pending writes. Invoked at the end of a serialization operation.

Defines a span writer.

Writes the given byte to the span at the given offset.

Writes the given double to the span at the given offset.

Writes the given float to the span at the given offset.

Writes the given int to the span at the given offset.

Writes the given long to the span at the given offset.

Writes the given sbyte to the span at the given offset.

Writes the given short to the span at the given offset.

Writes the given uint to the span at the given offset.

Writes the given ulong to the span at the given offset.

Writes the given ushort to the span at the given offset.

Writes the bytes of the given string to the destination span according to the given encoding.

Invokes the method.

An implementation of InputBuffer for writable memory segments.

An implemenation of InputBuffer that accepts ReadOnlyMemory. ReadOnlyMemoryInputBuffer behaves identically to MemoryInputBuffer with one exception, which is that it will refuse to deserialize any mutable memory (Memory{T}) instances. These will result in an exception being thrown. ReadOnlyMemoryInputBuffer guarantees that the objects returned will not modify in the input buffer (unless unsafe operations / MemoryMarshal) are used.

A shared string writer that uses a direct-map hash table.

Initializes a new shared string writer with the default capacity.

Initializes a new shared string writer with the given capacity.

The size of the hash table.

Resets the internal state to prepare for a new write operation.

Writes a shared string.

Flush any pending writes.

Utility class for writing items to spans.

An object that can read and write a FlatBuffer table from a buffer. The type of table this ISerializer supports is indicated by the property. The use of other types may cause undefined behavior.

Gets the root type for this serializer.

Gets the default DeserializationOption for this serializer.

Writes the given item to the buffer using the given spanwriter.

The span writer. The span to write to. The object to serialize. The number of bytes written.

Computes the maximum size necessary to serialize the given instance.

Parses the given buffer as an instance of this ISerializer's type.

The input buffer. The deserialization option. If null, the serializer's default setting is used.

Returns a new instance based on the current one with the given settings.

An object that can read and write from a buffer.

Gets the default DeserializationOption for this serializer.

Writes the given item to the buffer using the given spanwriter.

The span writer. The span to write to. The object to serialize. The number of bytes written.

Computes the maximum size necessary to serialize the given instance of .

Parses the given buffer as an instance of .

The input buffer. The deserialization option. If null, the serializer's default setting is used.

Returns a new instance based on the current one with the given settings.

Serializer extension methods.

Wraps the given generated serializer as an ISerializer.

Parses the given byte array as an instance of T.

The parsed instance.

Parses the given byte array.

The parsed instance.

Parses the given ArraySegment as an instance of T.

The parsed instance.

Parses the given ArraySegment as an instance of T.

The parsed instance.

Parses the given Memory as an instance of T.

The parsed instance.

Parses the given Memory as an instance of T.

The parsed instance.

Parses the given ReadOnlyMemory as an instance of T.

The parsed instance.

Parses the given ReadOnlyMemory as an instance of T.

The parsed instance.