Struct MetaData 

pub struct MetaData {
    pub name: SclName,
    pub resource_version: ResourceVersion,
    pub deletion_mark: Option<DeletionMark>,
}

Fields

name: SclName

resource_version: ResourceVersion

deletion_mark: Option<DeletionMark>

Will be set by the SCL API after it has received a delete request. Controllers will clean up related resources before the actual delete is performed.

Implementations

impl MetaData

pub fn new(name: SclName) -> Self

pub fn name(&self) -> &str

Returns the value of the name field.

pub fn may_be_deleted(&self) -> bool

Indicates whether a safe deletion (without remaining dangling references elsewhere) should be possible.

pub fn may_be_referenced(&self) -> bool

Indicates whether the object may be referenced by others. Currently, this is synonymous with the absence of a deletion mark.

pub fn validate_fields_before_create(&self) -> Result<()>

Checks if all fields are legal initial fields. Should be called before a create operation.

pub fn validate_fields_before_regular_update( current_db_state: &Self, proposed_new_state: &Self, ) -> Result<()>

Checks if a proposed updated is valid. Should be called before a regular (not related to finalizers / deletion) update.

pub fn validate_fields_before_finalizer_update( current_db_state: &Self, proposed_new_state: &Self, ) -> Result<()>

Checks if a proposed updated is valid. Should be called before a finalizer update. Does not check SclObject specific details related to FinalizerIds.

Trait Implementations

impl Clone for MetaData

fn clone(&self) -> MetaData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetaData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetaData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for MetaData

fn cmp(&self, other: &MetaData) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MetaData

fn eq(&self, other: &MetaData) -> 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 PartialOrd for MetaData

fn partial_cmp(&self, other: &MetaData) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MetaData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MetaData

impl StructuralPartialEq for MetaData