Struct Entity 

pub struct Entity {
    pub name: String,
    pub schema: VbrSchemaDefinition,
    pub table_name: String,
    pub state_machine: Option<StateMachine>,
}

Entity definition

Fields

name: String

Entity name

schema: VbrSchemaDefinition

Schema definition

table_name: String

Table name (derived from entity name)

state_machine: Option<StateMachine>

Optional state machine for this entity

If set, the entity can participate in state machine transitions. The state machine defines valid state transitions and lifecycle management.

Implementations

impl Entity

pub fn new(name: String, schema: VbrSchemaDefinition) -> Self

Create a new entity

pub fn with_state_machine( name: String, schema: VbrSchemaDefinition, state_machine: StateMachine, ) -> Self

Create a new entity with a state machine

pub fn set_state_machine(&mut self, state_machine: StateMachine)

Set the state machine for this entity

pub fn state_machine(&self) -> Option<&StateMachine>

Get the state machine for this entity

pub fn has_state_machine(&self) -> bool

Check if this entity has a state machine

pub async fn apply_state_transition( &self, database: &dyn VirtualDatabase, record_id: &str, new_state: &str, state_field_name: Option<&str>, ) -> Result<()>

Apply a state transition to an entity record

Updates the entity’s state field in the database based on the state machine transition. The state field name is typically derived from the state machine’s resource_type (e.g., “status” for “Order” resource type).

This method should be called after validating that the transition is allowed by the state machine.

pub async fn get_current_state( &self, database: &dyn VirtualDatabase, record_id: &str, state_field_name: Option<&str>, ) -> Result<Option<String>>

Get the current state of an entity record

Reads the state field from the database for a specific record.

pub async fn can_transition( &self, database: &dyn VirtualDatabase, record_id: &str, to_state: &str, state_field_name: Option<&str>, ) -> Result<bool>

Check if a state transition is allowed for an entity record

Validates that the transition from the current state to the new state is allowed by the entity’s state machine.

pub fn name(&self) -> &str

Get the entity name

pub fn table_name(&self) -> &str

Get the table name

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.