Skip to main content

EntityStatus

Enum EntityStatus 

Source
pub enum EntityStatus {
    New,
    Persisted,
    PersistedDeleted,
    Updated,
    UpdatedDeleted,
    UpdatedRecover,
    Refer,
}
Expand description

Tracks the lifecycle status of an entity through a state machine.

State transitions follow the Java TeaQL transition table exactly:

Current StateActionNext State
NewUpdateNew
NewPersistPersisted
PersistedUpdateUpdated
PersistedDeleteUpdatedDeleted
PersistedDeletedRecoverUpdatedRecover
UpdatedUpdateUpdated
UpdatedPersistPersisted
UpdatedDeletedPersistPersistedDeleted
UpdatedDeletedDeleteUpdatedDeleted
UpdatedRecoverPersistPersisted
UpdatedRecoverRecoverUpdatedRecover

Variants§

§

New

A newly created entity that has not been persisted yet.

§

Persisted

An entity that has been persisted to the database.

§

PersistedDeleted

A persisted entity that has been soft-deleted.

§

Updated

A persisted entity with pending updates.

§

UpdatedDeleted

A persisted entity that has been updated and then deleted.

§

UpdatedRecover

A deleted entity that has been recovered (undeleted).

§

Refer

A reference to an entity managed elsewhere.

Implementations§

Source§

impl EntityStatus

Source

pub fn next(self, action: EntityAction) -> Result<EntityStatus, String>

Transition to the next status given an action.

Returns Err with a descriptive message for invalid transitions.

Source

pub fn need_persist(&self) -> bool

Returns true if this entity needs to be persisted (i.e. it has pending changes).

Entities with status New, Updated, UpdatedDeleted, or UpdatedRecover need persistence. Persisted, PersistedDeleted, and Refer do not.

Source

pub fn is_new(&self) -> bool

Returns true if this entity is newly created and has never been persisted.

Source

pub fn is_updated(&self) -> bool

Returns true if this entity has been updated since last persistence.

Source

pub fn is_deleted(&self) -> bool

Returns true if this entity is marked for deletion.

Source

pub fn is_recover(&self) -> bool

Returns true if this entity has been recovered from deletion.

Trait Implementations§

Source§

impl Clone for EntityStatus

Source§

fn clone(&self) -> EntityStatus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EntityStatus

Source§

impl Debug for EntityStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EntityStatus

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for EntityStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for EntityStatus

Source§

impl Hash for EntityStatus

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EntityStatus

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for EntityStatus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.