com.kagekirin.unitymathematics.schemas.amalgamate
Version:
FlatBuffer schemas for Unity.Mathematics types This package also contains the following dependency assemblies:* FlatSharp.Runtime@7.8.0 * UnityMathematics.NoDeps@1.3.2
1,035 lines (1,032 loc) • 113 kB
text/xml
<?xml version="1.0"?>
<doc>
<assembly>
<name>FlatSharp.Runtime</name>
</assembly>
<members>
<member name="T:FlatSharp.Internal.ExternalDefinitionAttribute">
<summary>
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!
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatSharpInternal.AssertFlatSharpRuntimeVersionMatches(System.String)">
<summary>
Assert that the FlatSharp.Runtime assembly version matches the FlatSharp.Compiler assembly version.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatSharpInternal.AssertSizeOf``1(System.Int32)">
<summary>
Asserts that the type T has the expected size.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatSharpInternal.AssertLittleEndian">
<summary>
Asserts that the system is a LE architecture. This method is inlined because the condition can be evaluated at JIT time.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatSharpInternal.AssertWellAligned``1(System.Int32)">
<summary>
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.
</summary>
</member>
<member name="T:FlatSharp.Internal.IFlatBufferDeserializedVector">
<summary>
An interface implemented on buffer-backed Flatbuffer vectors. This interface is internal to FlatSharp and exposes some
functionality to assist with binary searching.
</summary>
</member>
<member name="P:FlatSharp.Internal.IFlatBufferDeserializedVector.InputBuffer">
<summary>
Gets the input buffer.
</summary>
</member>
<member name="P:FlatSharp.Internal.IFlatBufferDeserializedVector.ItemSize">
<summary>
Gets the raw item size of each element in the vector.
</summary>
</member>
<member name="P:FlatSharp.Internal.IFlatBufferDeserializedVector.Count">
<summary>
The number of items.
</summary>
</member>
<member name="P:FlatSharp.Internal.IFlatBufferDeserializedVector.OffsetBase">
<summary>
Gets the base offset of the vector.
</summary>
</member>
<member name="M:FlatSharp.Internal.IFlatBufferDeserializedVector.OffsetOf(System.Int32)">
<summary>
Returns the absolute position in the Input Buffer of the given index in the vector.
</summary>
</member>
<member name="M:FlatSharp.Internal.IFlatBufferDeserializedVector.ItemAt(System.Int32)">
<summary>
Gets the item at the given index.
</summary>
</member>
<member name="T:FlatSharp.Internal.GeneratedSerializerParseArguments">
<summary>
Wrapper struct to pass arguments into Parse methods on <see cref="T:FlatSharp.Internal.IGeneratedSerializer`1"/>.
</summary>
</member>
<member name="T:FlatSharp.Internal.IGeneratedSerializer`1">
<summary>
An interface implemented dynamically by FlatSharp for reading and writing data from a buffer.
</summary>
</member>
<member name="M:FlatSharp.Internal.IGeneratedSerializer`1.Write``1(``0,System.Span{System.Byte},`0,FlatSharp.Internal.SerializationContext)">
<summary>
Writes the given item to the buffer using the given spanwriter.
</summary>
<param name="writer">The span writer.</param>
<param name="destination">The span to write to.</param>
<param name="item">The object to serialize.</param>
<param name="context">The serialization context.</param>
</member>
<member name="M:FlatSharp.Internal.IGeneratedSerializer`1.GetMaxSize(`0)">
<summary>
Computes the maximum size necessary to serialize the given instance of <typeparamref name="T"/>.
</summary>
</member>
<member name="M:FlatSharp.Internal.IGeneratedSerializer`1.ParseLazy``1(``0,FlatSharp.Internal.GeneratedSerializerParseArguments@)">
<summary>
Parses the given buffer as an instance of <typeparamref name="T"/> from the given offset.
</summary>
</member>
<member name="M:FlatSharp.Internal.IGeneratedSerializer`1.ParseProgressive``1(``0,FlatSharp.Internal.GeneratedSerializerParseArguments@)">
<summary>
Parses the given buffer as an instance of <typeparamref name="T"/> from the given offset.
</summary>
</member>
<member name="M:FlatSharp.Internal.IGeneratedSerializer`1.ParseGreedy``1(``0,FlatSharp.Internal.GeneratedSerializerParseArguments@)">
<summary>
Parses the given buffer as an instance of <typeparamref name="T"/> from the given offset.
</summary>
</member>
<member name="M:FlatSharp.Internal.IGeneratedSerializer`1.ParseGreedyMutable``1(``0,FlatSharp.Internal.GeneratedSerializerParseArguments@)">
<summary>
Parses the given buffer as an instance of <typeparamref name="T"/> from the given offset.
</summary>
</member>
<member name="T:FlatSharp.Internal.InputBufferExtensions">
<summary>
Extensions for input buffers.
</summary>
</member>
<member name="M:FlatSharp.Internal.InputBufferExtensions.ReadBool``1(``0,System.Int32)">
<summary>
Reads a bool.
</summary>
</member>
<member name="M:FlatSharp.Internal.InputBufferExtensions.ReadString``1(``0,System.Int32)">
<summary>
Reads a string at the given offset.
</summary>
</member>
<member name="M:FlatSharp.Internal.InputBufferExtensions.ReadStringFromUOffset``1(``0,System.Int32)">
<summary>
Reads a string from the given uoffset.
</summary>
</member>
<member name="M:FlatSharp.Internal.InputBufferExtensions.ReadUOffset``1(``0,System.Int32)">
<summary>
Reads the given uoffset.
</summary>
</member>
<member name="M:FlatSharp.Internal.InputBufferExtensions.InitializeVTable``1(``0,System.Int32,System.Int32@,System.UIntPtr@,System.ReadOnlySpan{System.Byte}@)">
<summary>
Validates a vtable and reads the initial bytes of a vtable.
</summary>
</member>
<member name="M:FlatSharp.Internal.InputBufferExtensions.UnsafeReadSpan``2(``0,System.Int32)">
<summary>
Reads a sequence of TElement items from the buffer at the given offset using the equivalent of reinterpret_cast.
</summary>
</member>
<member name="T:FlatSharp.Internal.ScalarSpanReader">
<summary>
A class that reads FlatBuffer scalars.
</summary>
</member>
<member name="T:FlatSharp.Internal.SpanWriterExtensions">
<summary>
Extension methods that apply to all <see cref="T:FlatSharp.ISpanWriter"/> implementations.
</summary>
</member>
<member name="M:FlatSharp.Internal.SpanWriterExtensions.WriteString``1(``0,System.Span{System.Byte},System.String,System.Int32,FlatSharp.Internal.SerializationContext)">
<summary>
Writes the given string.
</summary>
</member>
<member name="M:FlatSharp.Internal.SpanWriterExtensions.WriteAndProvisionString``1(``0,System.Span{System.Byte},System.String,FlatSharp.Internal.SerializationContext)">
<summary>
Writes the string to the buffer, returning the absolute offset of the string.
</summary>
</member>
<member name="T:FlatSharp.Internal.ISpanComparer">
<summary>
An analog of IComparer for Spans. The implementation performs comparison consistent with the type the span represents.
</summary>
</member>
<member name="M:FlatSharp.Internal.ISpanComparer.Compare(System.Boolean,System.ReadOnlySpan{System.Byte},System.Boolean,System.ReadOnlySpan{System.Byte})">
<summary>
Compares the two spans.
</summary>
</member>
<member name="T:FlatSharp.Internal.SerializationContext">
<summary>
A context object for a FlatBuffer serialize operation. The context is responsible for allocating space in the buffer
and managing the latest offset.
</summary>
</member>
<member name="T:FlatSharp.Internal.SerializationContext.PostSerializeAction">
<summary>
A delegate to invoke after the serialization process has completed. Used for sorting vectors.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationContext.#ctor">
<summary>
Initializes a new serialization context.
</summary>
</member>
<member name="P:FlatSharp.Internal.SerializationContext.Offset">
<summary>
The maximum offset within the buffer.
</summary>
</member>
<member name="P:FlatSharp.Internal.SerializationContext.SharedStringWriter">
<summary>
The shared string writer used for this serialization operation.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationContext.Reset(System.Int32)">
<summary>
Resets the context.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationContext.InvokePostSerializeActions(System.Span{System.Byte})">
<summary>
Invokes any post-serialize actions.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationContext.AllocateVector(System.Int32,System.Int32,System.Int32)">
<summary>
Allocate a vector and return the index. Does not populate any details of the vector.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationContext.AllocateSpace(System.Int32,System.Int32)">
<summary>
Allocates a block of memory. Returns the offset.
</summary>
</member>
<member name="T:FlatSharp.Internal.SerializationHelpers">
<summary>
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.
</summary>
</member>
<member name="F:FlatSharp.Internal.SerializationHelpers.Encoding">
<summary>
Encoding used for strings.
</summary>
</member>
<member name="F:FlatSharp.Internal.SerializationHelpers.True">
<summary>
Value of true as a byte.
</summary>
</member>
<member name="F:FlatSharp.Internal.SerializationHelpers.False">
<summary>
Value of false as a byte.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationHelpers.GetMaxPadding(System.Int32)">
<summary>
Gets the maximum padding for the given alignment. This method seems simple,
but is inlined and is useful for generating more comprehensible IL.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationHelpers.CombineMask(System.Byte@,System.Byte)">
<summary>
Applies a bitwise OR to the operands.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationHelpers.GetAlignmentError(System.Int32,System.Int32)">
<summary>
Returns the number of padding bytes to be added to the given offset to acheive the given alignment.
</summary>
</member>
<member name="M:FlatSharp.Internal.SerializationHelpers.EnsureNonNull``1(``0)">
<summary>
Throws an InvalidDataException if the given item is null.
</summary>
<remarks>
Add generic constraint to catch errors calling this for value types.
</remarks>
</member>
<member name="M:FlatSharp.Internal.SerializationHelpers.EnsureDepthLimit(System.Int16)">
<summary>
Throws if the depth limit is less than 0.
</summary>
</member>
<member name="T:FlatSharp.Internal.SortedVectorHelpersInternal">
<summary>
Helper methods for dealing with sorted vectors. This class provides functionality for both sorting vectors and
binary searching through them.
</summary>
</member>
<member name="M:FlatSharp.Internal.SortedVectorHelpersInternal.SortVector``1(System.Span{System.Byte},System.Int32,System.Int32,System.Nullable{System.Int32},``0)">
<summary>
Sorts the given flatbuffer vector. This method, used incorrectly, is a fantastic way to corrupt your buffer.
</summary>
<remarks>
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.
</remarks>
</member>
<member name="M:FlatSharp.Internal.SortedVectorHelpersInternal.IntroSort``1(System.ReadOnlySpan{System.Byte},``0,System.Int32,System.Int32,System.Span{System.ValueTuple{System.Int32,System.Int32,System.Int32}})">
<summary>
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.
</summary>
</member>
<member name="M:FlatSharp.Internal.SortedVectorHelpersInternal.GetKeyOffset(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.Int32,System.Nullable{System.Int32})">
<summary>
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.
</summary>
<remarks>
Left as unchecked since this is a sort operation (not a search).
</remarks>
</member>
<member name="T:FlatSharp.Internal.StringSpanComparer">
<summary>
Implements string comparison for flatbuffers.
</summary>
<remarks>
Based on the FlatBuffer comparison here: https://github.com/google/flatbuffers/blob/3a70e0b30890ca265a33f099912762eb51ac505f/net/FlatBuffers/Table.cs
</remarks>
</member>
<member name="P:FlatSharp.Internal.StringSpanComparer.Instance">
<summary>
Singleton access.
</summary>
</member>
<member name="T:FlatSharp.Internal.TableFieldContext">
<summary>
A context containing information about the table field.
</summary>
</member>
<member name="F:FlatSharp.Internal.TableFieldContext.FullName">
<summary>
For debug purposes. Contains the full name of the associated table property.
</summary>
</member>
<member name="F:FlatSharp.Internal.TableFieldContext.SharedString">
<summary>
Indicates if this context enables shared strings.
</summary>
</member>
<member name="F:FlatSharp.Internal.TableFieldContext.WriteThrough">
<summary>
Indicates if this field is flagged as writethrough-enabled.
</summary>
</member>
<member name="T:FlatSharp.Internal.VectorCloneHelpers">
<summary>
Helper methods for deep-cloning vectors.
</summary>
</member>
<member name="T:FlatSharp.Internal.FlatBufferIndexedVector`2">
<summary>
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.
</summary>
</member>
<member name="P:FlatSharp.Internal.FlatBufferIndexedVector`2.IsReadOnly">
<summary>
Always readonly.
</summary>
</member>
<member name="P:FlatSharp.Internal.FlatBufferIndexedVector`2.Count">
<summary>
Gets the count of items.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferIndexedVector`2.Freeze">
<summary>
No-op. We are already immutable.
</summary>
</member>
<member name="T:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2">
<summary>
An <see cref="T:FlatSharp.IIndexedVector`2"/> implementation that loads data progressively.
</summary>
</member>
<member name="P:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.Item(`0)">
<summary>
An indexer for getting values by their keys.
</summary>
</member>
<member name="P:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.IsReadOnly">
<summary>
Indicates if this IndexedVector is read only.
</summary>
</member>
<member name="P:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.Count">
<summary>
Gets the count of items.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.Freeze">
<summary>
Freezes an Indexed vector, preventing further modifications.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.ContainsKey(`0)">
<summary>
Returns true if the vector contains the given key.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.TryGetValue(`0,`1@)">
<summary>
Tries to get the given value from the backing dictionary.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.GetEnumerator">
<summary>
Gets the dictionary's enumerator.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.System#Collections#IEnumerable#GetEnumerator">
<summary>
Gets a non-generic enumerator.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.AddOrReplace(`1)">
<summary>
Adds or replaces the item with the given key to the indexed vector.
</summary>
</member>
<member name="M:FlatSharp.Internal.FlatBufferProgressiveIndexedVector`2.Add(`1)">
<summary>
Attempts to add the value to the indexed vector, if a key does not already exist.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.GetKey(`1)">
<summary>
Gets the key from the given value.
</summary>
</member>
<member name="P:FlatSharp.Internal.GreedyIndexedVector`2.Item(`0)">
<summary>
An indexer for getting values by their keys.
</summary>
</member>
<member name="P:FlatSharp.Internal.GreedyIndexedVector`2.IsReadOnly">
<summary>
Indicates if this IndexedVector is read only.
</summary>
</member>
<member name="P:FlatSharp.Internal.GreedyIndexedVector`2.Count">
<summary>
Gets the count of items.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.Freeze">
<summary>
Freezes an Indexed vector, preventing further modifications.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.ContainsKey(`0)">
<summary>
Returns true if the vector contains the given key.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.TryGetValue(`0,`1@)">
<summary>
Tries to get the given value from the backing dictionary.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.GetEnumerator">
<summary>
Gets the dictionary's enumerator.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.System#Collections#IEnumerable#GetEnumerator">
<summary>
Gets a non-generic enumerator.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.AddOrReplace(`1)">
<summary>
Adds or replaces the item with the given key to the indexed vector.
</summary>
</member>
<member name="M:FlatSharp.Internal.GreedyIndexedVector`2.Add(`1)">
<summary>
Attempts to add the value to the indexed vector, if a key does not already exist.
</summary>
</member>
<member name="T:FlatSharp.Internal.ISortableTable`1">
<summary>
A table that may be sorted in a vector.
</summary>
</member>
<member name="T:FlatSharp.Internal.VectorsCommon">
<summary>
Common methods for all vectors.
</summary>
</member>
<member name="T:FlatSharp.Internal.VTable4">
<summary>
Represents a vtable for a table with up to 4 fields.
</summary>
</member>
<member name="M:FlatSharp.Internal.VTable4.CreateBigEndian``1(``0,System.Int32,FlatSharp.Internal.VTable4@)">
<summary>
A generic/safe initialize method for BE archtectures.
</summary>
</member>
<member name="M:FlatSharp.Internal.VTable4.CreateLittleEndian``1(``0,System.Int32,FlatSharp.Internal.VTable4@)">
<summary>
An optimized load mmethod for LE architectures.
</summary>
</member>
<member name="T:FlatSharp.Internal.VTable8">
<summary>
Represents a vtable for a table with up to 8 fields.
</summary>
</member>
<member name="M:FlatSharp.Internal.VTable8.CreateBigEndian``1(``0,System.Int32,FlatSharp.Internal.VTable8@)">
<summary>
A generic/safe initialize method for BE archtectures.
</summary>
</member>
<member name="M:FlatSharp.Internal.VTable8.CreateLittleEndian``1(``0,System.Int32,FlatSharp.Internal.VTable8@)">
<summary>
An optimized load mmethod for LE architectures.
</summary>
</member>
<member name="T:FlatSharp.Internal.VTableGeneric">
<summary>
Represents a vtable for an arbitrary table.
</summary>
</member>
<member name="T:FlatSharp.Attributes.FlatBufferEnumAttribute">
<summary>
Marks an enum as being elible for FlatSharp serialization.
</summary>
<remarks>
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.
</remarks>
</member>
<member name="M:FlatSharp.Attributes.FlatBufferEnumAttribute.#ctor(System.Type)">
<summary>
Initializes a new instance of the FlatBufferEnumAttribute class.
</summary>
<param name="underlyingType">The declared underlying type of the enum. This must match the enum's actual underlying type.</param>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferEnumAttribute.DeclaredUnderlyingType">
<summary>
The declared underlying type. This is a saftey check to prevent unintended binary breaks.
</summary>
</member>
<member name="T:FlatSharp.Attributes.FlatBufferItemAttribute">
<summary>
Defines a member of a FlatBuffer struct or table.
</summary>
</member>
<member name="M:FlatSharp.Attributes.FlatBufferItemAttribute.#ctor(System.UInt16)">
<summary>
Initializes a new FlatBufferItemAttribute.
</summary>
<param name="index">The field index within the struct or table.</param>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.Index">
<summary>
The index within the struct or table.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.Deprecated">
<summary>
For tables, indicates if this field is deprecated. Deprecated fields are not written or read.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.SortedVector">
<summary>
Indicates that the given vector property is to be serialized sorted by the key property of the vector type.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.Key">
<summary>
Indicates that this field is the key for the table. Keys are used when sorting inside a vector. Only valid on a table.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.DefaultValue">
<summary>
For table items, gets or sets the default value. The type of the object must match the
type of the property.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.ForceWrite">
<summary>
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.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.WriteThrough">
<summary>
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.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.Required">
<summary>
When set, indicates that the field is required. Only applies to non-scalar fields on tables.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferItemAttribute.SharedString">
<summary>
Indicates if strings within this vector or item should be shared.
</summary>
</member>
<member name="T:FlatSharp.Attributes.FlatBufferMetadataKind">
<summary>
Describes kinds of metadata.
</summary>
</member>
<member name="F:FlatSharp.Attributes.FlatBufferMetadataKind.Accessor">
<summary>
A custom get/set accessor for a flatbuffer field.
</summary>
</member>
<member name="F:FlatSharp.Attributes.FlatBufferMetadataKind.FbsAttribute">
<summary>
A FBS attribute
</summary>
</member>
<member name="T:FlatSharp.Attributes.FlatBufferMetadataAttribute">
<summary>
Defines a member of a FlatBuffer struct or table.
</summary>
</member>
<member name="M:FlatSharp.Attributes.FlatBufferMetadataAttribute.#ctor(FlatSharp.Attributes.FlatBufferMetadataKind,System.String,System.String)">
<summary>
Initializes a new FlatBufferMetadataAttribute.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferMetadataAttribute.Key">
<summary>
The key.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferMetadataAttribute.Value">
<summary>
The value.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferMetadataAttribute.Kind">
<summary>
The kind of metadata.
</summary>
</member>
<member name="T:FlatSharp.Attributes.MemoryMarshalBehavior">
<summary>
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 <see cref="M:System.Runtime.InteropServices.MemoryMarshal.Cast``2(System.Span{``0})"/>.
</summary>
</member>
<member name="F:FlatSharp.Attributes.MemoryMarshalBehavior.Never">
<summary>
Never. Always use field by field copies.
</summary>
</member>
<member name="F:FlatSharp.Attributes.MemoryMarshalBehavior.Default">
<summary>
Flatsharp will choose when to enable memory marshalling. This can change from release to release.
</summary>
</member>
<member name="F:FlatSharp.Attributes.MemoryMarshalBehavior.Serialize">
<summary>
Memory marshalling is enabled when serializing only.
</summary>
</member>
<member name="F:FlatSharp.Attributes.MemoryMarshalBehavior.Parse">
<summary>
Memory marshalling is enabled when parsing only.
</summary>
</member>
<member name="F:FlatSharp.Attributes.MemoryMarshalBehavior.Always">
<summary>
Memory marshalling is enabled for both serializing and parsing.
</summary>
</member>
<member name="T:FlatSharp.Attributes.FlatBufferStructAttribute">
<summary>
Marks a class as being a FlatBuffer struct.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferStructAttribute.MemoryMarshalBehavior">
<summary>
Enables reading and writing value structs with calls to MemoryMarshal.Cast.
</summary>
</member>
<member name="T:FlatSharp.Attributes.FlatBufferTableAttribute">
<summary>
Marks a class as being a FlatBuffer table.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferTableAttribute.FileIdentifier">
<summary>
Specifies the file identifier for serialized tables. Must be precisely 4 ASCII characters.
</summary>
</member>
<member name="P:FlatSharp.Attributes.FlatBufferTableAttribute.BuildSerializer">
<summary>
Indicates that a serializer should be built for the given table.
</summary>
</member>
<member name="T:FlatSharp.BufferTooSmallException">
<summary>
Raised in serialization when the provided buffer was too small.
</summary>
</member>
<member name="P:FlatSharp.BufferTooSmallException.SizeNeeded">
<summary>
The maximum amount of size needed for this message.
</summary>
</member>
<member name="T:FlatSharp.FlatBufferDeserializationContext">
<summary>
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.
</summary>
</member>
<member name="M:FlatSharp.FlatBufferDeserializationContext.#ctor(FlatSharp.FlatBufferDeserializationOption)">
<summary>
Initializes a new FlatSharpConstructorContext with the given deserialization option.
</summary>
</member>
<member name="P:FlatSharp.FlatBufferDeserializationContext.DeserializationOption">
<summary>
The deserialization options used to create the current subclass.
</summary>
</member>
<member name="T:FlatSharp.FlatBufferDeserializationOption">
<summary>
Defines FlatSharp deserialization options.
</summary>
</member>
<member name="F:FlatSharp.FlatBufferDeserializationOption.Lazy">
<summary>
Full Lazy parsing. Deserialized objects are immutable.
</summary>
</member>
<member name="F:FlatSharp.FlatBufferDeserializationOption.Progressive">
<summary>
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.
</summary>
</member>
<member name="F:FlatSharp.FlatBufferDeserializationOption.Greedy">
<summary>
The entire object graph is traversed and the deserialized objects do not reference the input buffer. Deserialized objects are immutable.
</summary>
</member>
<member name="F:FlatSharp.FlatBufferDeserializationOption.GreedyMutable">
<summary>
The entire object graph is traversed and the deserialized objects do not reference the input buffer. Deserialized objects are mutable.
</summary>
</member>
<member name="F:FlatSharp.FlatBufferDeserializationOption.Default">
<summary>
Default options.
</summary>
</member>
<member name="T:FlatSharp.GeneratedSerializerWrapper`1">
<summary>
An implementation of <see cref="T:FlatSharp.ISerializer`1"/> that wraps a <see cref="T:FlatSharp.Internal.IGeneratedSerializer`1"/>.
</summary>
</member>
<member name="T:FlatSharp.IFlatBufferDeserializedObject">
<summary>
An interface applied to objects deserialized by FlatSharp. FlatSharp implements this
interface on deserialized objects. It should not be implemented externally.
</summary>
</member>
<member name="P:FlatSharp.IFlatBufferDeserializedObject.TableOrStructType">
<summary>
The actual type of the table or struct. This is generally the base class.
</summary>
</member>
<member name="P:FlatSharp.IFlatBufferDeserializedObject.DeserializationContext">
<summary>
The context of the deserialized object.
</summary>
</member>
<member name="P:FlatSharp.IFlatBufferDeserializedObject.InputBuffer">
<summary>
Gets the input buffer instance used to lazily read this object.
This buffer will not have a value when the derserialization mode
is <see cref="F:FlatSharp.FlatBufferDeserializationOption.Greedy"/> or
<see cref="F:FlatSharp.FlatBufferDeserializationOption.GreedyMutable"/>.
</summary>
</member>
<member name="P:FlatSharp.IFlatBufferDeserializedObject.CanSerializeWithMemoryCopy">
<summary>
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.
</summary>
</member>
<member name="T:FlatSharp.IFlatBufferSerializable">
<summary>
An object that can supply an <see cref="T:FlatSharp.ISerializer"/> instance that can serialize and parse it.
</summary>
</member>
<member name="P:FlatSharp.IFlatBufferSerializable.Serializer">
<summary>
Gets a <see cref="T:FlatSharp.ISerializer"/> instance that can serialize this object.
</summary>
</member>
<member name="T:FlatSharp.IFlatBufferSerializable`1">
<summary>
An object that can supply an <see cref="T:FlatSharp.ISerializer`1"/> instance that can serialize and parse it.
</summary>
</member>
<member name="P:FlatSharp.IFlatBufferSerializable`1.Serializer">
<summary>
Gets a <see cref="T:FlatSharp.ISerializer`1"/> instance that can serialize instances of <typeparamref name="T"/>.
</summary>
</member>
<member name="T:FlatSharp.ArrayInputBuffer">
<summary>
An implementation of <see cref="T:FlatSharp.IInputBuffer"/> for managed arrays.
</summary>
</member>
<member name="T:FlatSharp.ArraySegmentInputBuffer">
<summary>
An implementation of <see cref="T:FlatSharp.IInputBuffer"/> for array segments.
</summary>
</member>
<member name="T:FlatSharp.IInputBuffer">
<summary>
Defines a buffer that FlatSharp can parse from. Implementations will be fastest when using a struct.
</summary>
</member>
<member name="P:FlatSharp.IInputBuffer.IsReadOnly">
<summary>
Indicates if this instance is read only.
</summary>
</member>
<member name="P:FlatSharp.IInputBuffer.IsPinned">
<summary>
Indicates if this instance represents pinned (non-movable) memory.
</summary>
</member>
<member name="P:FlatSharp.IInputBuffer.Length">
<summary>
Gets the length of this input buffer.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadByte(System.Int32)">
<summary>
Reads the byte at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadSByte(System.Int32)">
<summary>
Reads the sbyte at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadUShort(System.Int32)">
<summary>
Reads the ushort at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadShort(System.Int32)">
<summary>
Reads the short at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadUInt(System.Int32)">
<summary>
Reads the uint at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadInt(System.Int32)">
<summary>
Reads the int at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadULong(System.Int32)">
<summary>
Reads the ulong at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadLong(System.Int32)">
<summary>
Reads the long at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadFloat(System.Int32)">
<summary>
Reads the float at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadDouble(System.Int32)">
<summary>
Reads the double at the given offset.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.ReadString(System.Int32,System.Int32,System.Text.Encoding)">
<summary>
Reads the string of the given length at the given offset with the given encoding.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.GetReadOnlySpan">
<summary>
Gets a read only span covering the entire input buffer.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.GetReadOnlyMemory">
<summary>
Gets a read only memory covering the entire input buffer.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.GetSpan">
<summary>
Gets a span covering the entire input buffer.
</summary>
</member>
<member name="M:FlatSharp.IInputBuffer.GetMemory">
<summary>
Gets a memory covering the entire input buffer.
</summary>
</member>
<member name="T:FlatSharp.ISharedStringWriter">
<summary>
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.
</summary>
</member>
<member name="P:FlatSharp.ISharedStringWriter.IsDirty">
<summary>
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.
</summary>
</member>
<member name="M:FlatSharp.ISharedStringWriter.Reset">
<summary>
Invoked before a new write operation begins.
</summary>
</member>
<member name="M:FlatSharp.ISharedStringWriter.WriteSharedString``1(``0,System.Span{System.Byte},System.Int32,System.String,FlatSharp.Internal.SerializationContext)">
<summary>
Writes the given string to the span.
</summary>
<param name="spanWriter">The spanwriter.</param>
<param name="data">The span.</param>
<param name="offset">The location in the buffer of the uoffset to the string.</param>
<param name="value">The string to write.</param>
<param name="context">The serialization context.</param>
</member>
<member name="M:FlatSharp.ISharedStringWriter.FlushWrites``1(``0,System.Span{System.Byte},FlatSharp.Internal.SerializationContext)">
<summary>
Flushes any pending writes. Invoked at the end of a serialization operation.
</summary>
</member>
<member name="T:FlatSharp.ISpanWriter">
<summary>
Defines a span writer.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteByte(System.Span{System.Byte},System.Byte,System.Int32)">
<summary>
Writes the given byte to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteDouble(System.Span{System.Byte},System.Double,System.Int32)">
<summary>
Writes the given double to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteFloat(System.Span{System.Byte},System.Single,System.Int32)">
<summary>
Writes the given float to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteInt(System.Span{System.Byte},System.Int32,System.Int32)">
<summary>
Writes the given int to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteLong(System.Span{System.Byte},System.Int64,System.Int32)">
<summary>
Writes the given long to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteSByte(System.Span{System.Byte},System.SByte,System.Int32)">
<summary>
Writes the given sbyte to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteShort(System.Span{System.Byte},System.Int16,System.Int32)">
<summary>
Writes the given short to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteUInt(System.Span{System.Byte},System.UInt32,System.Int32)">
<summary>
Writes the given uint to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteULong(System.Span{System.Byte},System.UInt64,System.Int32)">
<summary>
Writes the given ulong to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.WriteUShort(System.Span{System.Byte},System.UInt16,System.Int32)">
<summary>
Writes the given ushort to the span at the given offset.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.GetStringBytes(System.Span{System.Byte},System.String,System.Text.Encoding)">
<summary>
Writes the bytes of the given string to the destination span according to the given encoding.
</summary>
</member>
<member name="M:FlatSharp.ISpanWriter.FlushSharedStrings(FlatSharp.ISharedStringWriter,System.Span{System.Byte},FlatSharp.Internal.SerializationContext)">
<summary>
Invokes the <see cref="M:FlatSharp.ISharedStringWriter.FlushWrites``1(``0,System.Span{System.Byte},FlatSharp.Internal.SerializationContext)"/> method.
</summary>
</member>
<member name="T:FlatSharp.MemoryInputBuffer">
<summary>
An implementation of InputBuffer for writable memory segments.
</summary>
</member>
<member name="T:FlatSharp.ReadOnlyMemoryInputBuffer">
<summary>
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.
</summary>
</member>
<member name="T:F