Struct SeparationContext 

pub struct SeparationContext {
    pub metadata: MetaData,
    pub vlan_tag: VlanTag,
}

Fields

metadata: MetaData

vlan_tag: VlanTag

Values provided by the client will be ignored as vlan tags will be assigned by the server and may not change afterwards.

Trait Implementations

impl Clone for SeparationContext

fn clone(&self) -> SeparationContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SeparationContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SeparationContext

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for SeparationContext

fn cmp(&self, other: &SeparationContext) -> 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 SeparationContext

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

fn partial_cmp(&self, other: &SeparationContext) -> 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 SclObject for SeparationContext

const PREFIX: &'static str = "/scs"

Prefix for all SeparationContexts ("/scs").

fn separation_context(&self) -> Option<&SclName>

Returns the SclName of the SeparationContext, as each separation context is associated with itself.

Examples

use scl_lib::api_objects::{MetaData, SclName, SclObject, SeparationContext, VlanTag};

let sc = SeparationContext {
  vlan_tag: VlanTag::try_from(1).unwrap(),
  metadata: MetaData::new(SclName::try_from("sc-01").unwrap()),
};
assert_eq!(sc.separation_context(), Some(sc.name()));

fn api_endpoint<'a>( sc: impl Into<Option<&'a str>>, name: impl Into<Option<&'a str>>, ) -> String

Overrides the default implementation of the SclObject trait to use either the sc or the name argument for API endpoint construction.

Examples

use scl_lib::api_objects::{SeparationContext, SclObject};

assert_eq!(SeparationContext::api_endpoint("sc-01", None), SeparationContext::api_endpoint(None, "sc-01"));
assert_eq!(SeparationContext::api_endpoint("sc-01", "sc-01"), SeparationContext::api_endpoint("sc-01", None));
assert_eq!(SeparationContext::api_endpoint(None, None), SeparationContext::PREFIX);

fn db_key<'a>( sc: impl Into<Option<&'a str>>, name: impl Into<Option<&'a str>>, ) -> String

Overrides the default implementation of the SclObject trait to use either the sc or the name argument for DB key construction.

Examples

use scl_lib::api_objects::{SeparationContext, SclObject};

assert_eq!(SeparationContext::db_key("sc-01", None), SeparationContext::db_key(None, "sc-01"));
assert_eq!(SeparationContext::db_key("sc-01", "sc-01"), SeparationContext::db_key("sc-01", None));
assert_eq!(SeparationContext::db_key(None, None), SeparationContext::PREFIX);

fn name(&self) -> &SclName

Returns the SclName of the SclObject.

fn metadata(&self) -> &MetaData

Providing access to MetaData is essential for our optimistic concurrency control.

fn metadata_mut(&mut self) -> &mut MetaData

Providing access to MetaData is essential for our optimistic concurrency control.

fn referenced_db_keys(&self) -> Vec<String>

Returns all DB keys the object is referencing / depending on.

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

Checks if all fields (except references to other SclObjects) are legal initial fields. Should be called before a create operation.

fn validate_fields_before_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 operation.

fn uuid(&self) -> Uuid

fn get_api_endpoint(&self) -> String

Returns the API endpoint of the SclObject.

fn get_db_key(&self) -> String

Returns the database key of the SclObject.

impl Serialize for SeparationContext

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 SeparationContext

impl StructuralPartialEq for SeparationContext