Struct EntitySchemaDescription 

pub struct EntitySchemaDescription { /* private fields */ }

EntitySchemaDescription

Stable describe payload for one entity model.

Implementations

impl EntitySchemaDescription

pub fn new( entity_path: String, entity_name: String, primary_key: String, fields: Vec<EntityFieldDescription>, indexes: Vec<EntityIndexDescription>, relations: Vec<EntityRelationDescription>, ) -> Self

Construct one scalar-compatible entity schema description payload.

pub const fn new_with_primary_key_fields( entity_path: String, entity_name: String, primary_key: String, primary_key_fields: Vec<String>, fields: Vec<EntityFieldDescription>, indexes: Vec<EntityIndexDescription>, relations: Vec<EntityRelationDescription>, ) -> Self

Construct one entity schema description payload with ordered primary-key fields.

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 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 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.

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 PartialEq for EntitySchemaDescription

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EntitySchemaDescription

impl StructuralPartialEq for EntitySchemaDescription