Struct Controller 

pub struct Controller {
    pub metadata: MetaData,
    pub kind: ControllerKind,
    pub status: ControllerStatus,
}

Fields

metadata: MetaData

kind: ControllerKind

status: ControllerStatus

Latest status of the controller. Does not need to be specified by the user when creating (POST), as it is initialized with the default values.

Implementations

impl Controller

pub fn new(name: SclName, kind: ControllerKind) -> Self

pub fn update_last_interaction(&mut self)

Trait Implementations

impl Clone for Controller

fn clone(&self) -> Controller

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Controller

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Controller

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for Controller

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

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

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

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

Prefix for all Controllers ("/controllers").

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 ignore the sc argument when constructing API endpoints.

Examples

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

assert_eq!(Controller::api_endpoint(None, "ctrl-01"), "/controllers/ctrl-01");
assert_eq!(Controller::api_endpoint(None, "ctrl-01"), Controller::api_endpoint("ctrl-01", "ctrl-01"));
assert_eq!(Controller::api_endpoint("ctrl-01", None), Controller::api_endpoint(None, None));
assert_eq!(Controller::api_endpoint(None, None), Controller::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::{Controller, SclObject};

assert_eq!(Controller::db_key(None, "ctrl-01"), "/controllers/ctrl-01");
assert_eq!(Controller::db_key(None, "ctrl-01"), Controller::db_key("ctrl-01", "ctrl-01"));
assert_eq!(Controller::db_key("ctrl-01", None), Controller::db_key(None, None));
assert_eq!(Controller::db_key(None, None), Controller::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<(), Error>

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<(), Error>

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 separation_context(&self) -> Option<&SclName>

Returns the SclName of the separation context if the SclObject is connected to one, otherwise default None.

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 Controller

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 Controller

impl StructuralPartialEq for Controller