Struct architect_sdk::common::Common

pub struct Common(pub Arc<CommonInner>);

Common data and functionality shared by most everything in the core, derived from the config.

Tuple Fields

0: Arc<CommonInner>

Implementations

impl Common

Attach the stats system to Common

pub fn init_stats(&self, service: &str, is_local: bool) -> Result<()>

Initialize the stats system for publishing statistics under $base/admin/$service/$host and also $base/admin/$host/$service

pub fn stat_set(&self, path: impl Into<Path>, stat: impl Into<Value>)

Publishes a stat. Stats are published under ${base}/admin by component and by host A prior call to init_stats must have been made otherwise this will be a no-op.

Arguments

• path - a relative path describing this stat
• stat - the value of this stat

pub fn stat_add_acc(&self, path: impl Into<Path>, stat: impl Into<Value>)

Add accumulates an existing stat. If the existing stat is not initialized then it assumed to be zero.

pub fn stat_sub_acc(&self, path: impl Into<Path>, stat: impl Into<Value>)

Sutract accumulates an existing stat. If the existing stat is not initialized then it is assumed to be zero.

pub fn stat_mul_acc(&self, path: impl Into<Path>, stat: impl Into<Value>)

Multiply accumulates an existing stat. If the existing stat is not initialized then it assumed to be zero

pub fn stat_div_acc(&self, path: impl Into<Path>, stat: impl Into<Value>)

Divide accumulates an existing stat. If the existing stat is not initialized then it is assumed to be zero

impl Common

pub async fn from_config( config_path: Option<PathBuf>, f: Config, ) -> Result<Self>

pub async fn load<P: AsRef<Path>>(path: P) -> Result<Self>

Load from the specified file

pub async fn load_default() -> Result<Self>

Load from the default location

pub fn get_tls_identity(&self) -> Result<(&Tls, &TlsIdentity)>

Get the architect tls identity

pub fn load_private_key(&self) -> Result<Rsa<Private>>

Load and decrypt the private key from the configured identity Note this does blocking operations, so within an async context call it with block_in_place

pub fn load_certificate(&self) -> Result<X509>

Load the public key/certificate from the configured identity. Note this does blocking operations, so within an async context call it with block_in_place

pub fn get_local_component_of_kind(&self, kind: &str) -> Option<ComponentId>

pub fn find_local_component_of_kind(&self, kind: &str) -> Result<ComponentId>

pub fn get_component_of_kind(&self, kind: &str) -> Option<ComponentId>

pub fn find_component_of_kind(&self, kind: &str) -> Result<ComponentId>

pub fn all_components(&self, filter: impl Fn(&str) -> bool) -> Vec<ComponentId>

pub fn all_components_of_kind(&self, kind: &str) -> Vec<ComponentId>

pub async fn start_symbology(&self, write: bool) -> Client

Convenience function to initialize symbology from Common

pub fn channel_driver(&self) -> ChannelDriverBuilder<'_>

Trait Implementations

impl Clone for Common

fn clone(&self) -> Common

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Common

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

Formats the value using the given formatter.

impl Deref for Common

type Target = CommonInner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.