Struct FieldR1

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

Persisted schema descriptor for a single field of a component (revision-1 layout). Stored inside the owning component's Fields collection to make the database self-describing.

public struct FieldR1

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Fields

ArrayLength

Element count when the field is a fixed-length array; 0 for scalar fields (see IsArray).

public int ArrayLength

Field Value

int

FieldId

Stable numeric id of the field within its component.

public int FieldId

Field Value

int

HasIndex

true when the field is indexed.

public bool HasIndex

Field Value

bool

IndexAllowMultiple

true when the field's index permits multiple entries per key (multi-value index).

public bool IndexAllowMultiple

Field Value

bool

IndexSPI

Root page index (SPI) of this field's dedicated index segment; 0 when the field has no such segment.

public uint IndexSPI

Field Value

uint

IsStatic

true when the field is declared static — not stored per entity, and excluded from FieldCount.

public bool IsStatic

Field Value

bool

Name

Field name as declared on the component POCO.

public String64 Name

Field Value

String64

OffsetInComponentStorage

Byte offset of the field within the component's per-entity storage.

public int OffsetInComponentStorage

Field Value

int

SchemaName

Fully-qualified schema name of this field-descriptor record ("Typhon.Schema.Field").

public const string SchemaName = "Typhon.Schema.Field"

Field Value

string

SizeInComponentStorage

Byte size of the field within the component's per-entity storage.

public int SizeInComponentStorage

Field Value

int

Type

Logical field type.

public FieldType Type

Field Value

FieldType

UnderlyingType

For an enum field, the primitive type backing the enum; equal to Type for non-enum fields.

public FieldType UnderlyingType

Field Value

FieldType

Properties

IsArray

true when ArrayLength > 0, i.e. the field is a fixed-length array.

public bool IsArray { get; }

Property Value

bool