Skip to main content

Crate oxgraph_property

Crate oxgraph_property 

Source
Expand description

Arrow-backed named property layers for OxGraph topology views.

oxgraph-property is a higher layer than topology. It stores named typed Arrow arrays keyed by topology ID family and adapts selected total primitive layers into topology weight capabilities. Foundation crates do not depend on this crate, Arrow, or named properties.

§Snapshot section kinds

Constant familyDescription
PROPERTY_DESCRIPTORS_*Per-layer descriptor records (header + records + string table)
PROPERTY_DATA_*Concatenated Arrow IPC value and sparse-default streams

The _U16 / _U32 / _U64 suffix selects the descriptor metadata word width. The payload format is owned by this crate and remains an OxGraph-internal ABI candidate while snapshot v1 bytes are not stable. All section-kind constants are perf: unspecified — compile-time u32 tags.

Structs§

DecodedPropertyLayer
One property layer decoded from snapshot bytes.
DenseWeights
Selected dense primitive weights bound to one axis of a topology view.
ElementAxis
Element-keyed axis marker.
EncodedPropertySnapshot
Encoded property descriptor and Arrow IPC data payloads.
GraphPropertyLayers
Borrowed graph property layers partitioned by topology ID family.
HyperPropertyLayers
Borrowed hypergraph property layers partitioned by topology ID family.
IdentityModeRecord
Wire record declaring one identity family map mode.
IdentityModeSummary
Decoded identity mode summary.
IdentitySnapshotSummary
Summary returned after identity snapshot validation.
IncidenceAxis
Incidence-keyed axis marker.
LayerId
Stable numeric identifier for one property layer.
LayerName
Human-facing property layer name.
PropertyLayer
Arrow-backed property layer.
PropertyLayerDescriptor
Descriptor for one Arrow-backed property layer.
PropertySnapshotRecord
Wire descriptor record for one property layer.
PropertySnapshotSummary
Summary returned after property snapshot validation.
RelationAxis
Relation-keyed axis marker.
SparseWeights
Selected sparse primitive weights bound to one axis of a topology view.

Enums§

DecodedPropertyData
Arrow payload of a property layer decoded from snapshot bytes.
IdFamily
Topology ID family keyed by a property layer.
IdentityMapMode
Identity snapshot map mode.
LayerRole
Declared role of a property layer.
MissingPolicy
Missing-value policy for sparse property layers.
PropertyError
Errors raised while validating property descriptors, layers, or snapshots.
PropertyLayerData
Data backing one property layer.
StorageMode
Physical storage mode for a property layer.

Constants§

SNAPSHOT_KIND_ELEMENT_IDENTITY_MAP_U16
Snapshot section kind for element local-to-canonical u16 maps.
SNAPSHOT_KIND_ELEMENT_IDENTITY_MAP_U32
Snapshot section kind for element local-to-canonical u32 maps.
SNAPSHOT_KIND_ELEMENT_IDENTITY_MAP_U64
Snapshot section kind for element local-to-canonical u64 maps.
SNAPSHOT_KIND_IDENTITY_MODES_U16
Snapshot section kind for u16 identity-mode metadata records.
SNAPSHOT_KIND_IDENTITY_MODES_U32
Snapshot section kind for u32 identity-mode metadata records.
SNAPSHOT_KIND_IDENTITY_MODES_U64
Snapshot section kind for u64 identity-mode metadata records.
SNAPSHOT_KIND_INCIDENCE_IDENTITY_MAP_U16
Snapshot section kind for incidence local-to-canonical u16 maps.
SNAPSHOT_KIND_INCIDENCE_IDENTITY_MAP_U32
Snapshot section kind for incidence local-to-canonical u32 maps.
SNAPSHOT_KIND_INCIDENCE_IDENTITY_MAP_U64
Snapshot section kind for incidence local-to-canonical u64 maps.
SNAPSHOT_KIND_PROPERTY_DATA_U16
Snapshot section kind reserved for u16 Arrow IPC property-layer payloads.
SNAPSHOT_KIND_PROPERTY_DATA_U32
Snapshot section kind reserved for u32 Arrow IPC property-layer payloads.
SNAPSHOT_KIND_PROPERTY_DATA_U64
Snapshot section kind reserved for u64 Arrow IPC property-layer payloads.
SNAPSHOT_KIND_PROPERTY_DESCRIPTORS_U16
Snapshot section kind reserved for u16 property-layer descriptors.
SNAPSHOT_KIND_PROPERTY_DESCRIPTORS_U32
Snapshot section kind reserved for u32 property-layer descriptors.
SNAPSHOT_KIND_PROPERTY_DESCRIPTORS_U64
Snapshot section kind reserved for u64 property-layer descriptors.
SNAPSHOT_KIND_RELATION_IDENTITY_MAP_U16
Snapshot section kind for relation local-to-canonical u16 maps.
SNAPSHOT_KIND_RELATION_IDENTITY_MAP_U32
Snapshot section kind for relation local-to-canonical u32 maps.
SNAPSHOT_KIND_RELATION_IDENTITY_MAP_U64
Snapshot section kind for relation local-to-canonical u64 maps.
SNAPSHOT_PROPERTY_VERSION
Internal property/identity snapshot section version.

Traits§

AxisIndex
Axis-aware topology bound accessor.
PropertyAxis
Marker trait selecting which axis of a topology view a property layer keys against (elements, relations, or incidences).
PropertyIndex
Unsigned index width usable for sparse property indexes.
PropertySnapshotMetaWord
Metadata/canonical-ID word width for property and identity snapshot sections.

Functions§

encode_graph_property_snapshot
Encodes graph property layers into descriptor/data payloads.
encode_hyper_property_snapshot
Encodes hypergraph property layers into descriptor/data payloads.
encode_property_snapshot
Encodes property descriptor and Arrow IPC data sections.
rekey_layer_to_local
Rekeys a property layer from canonical order into snapshot-local order.
validate_identity_snapshot
Validates identity mode and explicit map sections in a snapshot.
validate_property_sections
Validates raw property descriptor and data section payloads.
validate_property_snapshot
Validates property descriptor/data sections in a snapshot.
validate_unique_layer_ids
Validates that layer IDs are unique within one descriptor set.
validate_unique_names
Validates that layer names are unique within each ID-family namespace.