Struct EntitySchemaDescription 

pub struct EntitySchemaDescription { /* private fields */ }

EntitySchemaDescription

Stable describe payload for one entity model.

Implementations

impl EntitySchemaDescription

pub const fn new( entity_path: String, entity_name: String, entity_tag: u64, accepted_schema_fingerprint_method: u8, accepted_schema_fingerprint: [u8; 16], primary_key: String, primary_key_fields: Vec<String>, fields: Vec<EntityFieldDescription>, indexes: Vec<EntityIndexDescription>, relations: Vec<EntityRelationDescription>, constraints: Vec<EntityConstraintDescription>, row_layout_current: u32, row_layout_history_floor: u32, ) -> Self

Construct one entity schema description payload.

pub const fn entity_path(&self) -> &str

Borrow the entity module path.

pub const fn entity_name(&self) -> &str

Borrow the entity display name.

pub const fn entity_tag(&self) -> u64

Return the accepted durable entity identity used by diagnostic facts.

pub const fn accepted_schema_fingerprint_method(&self) -> u8

Return the accepted schema-fingerprint method used by diagnostic facts.

pub const fn accepted_schema_fingerprint(&self) -> [u8; 16]

Return the exact accepted entity-schema fingerprint.

pub const fn primary_key(&self) -> &str

Borrow the rendered primary-key field list.

pub const fn primary_key_fields(&self) -> &[String]

Borrow ordered primary-key field names.

pub fn identity(&self) -> Option<&EntityIdentityDescription>

Borrow the accepted Identity policy and lifetime allocation state.

pub const fn fields(&self) -> &[EntityFieldDescription]

Borrow field description entries.

pub const fn indexes(&self) -> &[EntityIndexDescription]

Borrow index description entries.

pub const fn relations(&self) -> &[EntityRelationDescription]

Borrow relation description entries.

pub const fn constraints(&self) -> &[EntityConstraintDescription]

Borrow accepted or generated structural constraint descriptions.

pub const fn row_layout_current(&self) -> u32

Return the current accepted physical row-layout identity.

pub const fn row_layout_history_floor(&self) -> u32

Return the oldest admitted physical row-layout identity.

Trait Implementations

impl CandidType for EntitySchemaDescription

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for EntitySchemaDescription

fn clone(&self) -> EntitySchemaDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EntitySchemaDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntitySchemaDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EntitySchemaDescription

impl PartialEq for EntitySchemaDescription

fn eq(&self, other: &EntitySchemaDescription) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EntitySchemaDescription