Struct State

pub struct State<T = ()> { /* private fields */ }

A state is a record of the env, config and associated data.

Implementations

impl<T> State<T>

pub fn new(env: Env, data: T) -> Self

Creates a new instance.

pub fn load_config(&mut self)

Loads the config according to the specific env.

Note

It supports the json or toml format of configuration source data, which can be specified by the environment variable ZINO_APP_CONFIG_FORMAT. By default, it reads the config from a local file. If ZINO_APP_CONFIG_URL is set, it will fetch the config from the URL instead.

pub fn set_data(&mut self, data: T)

Set the state data.

pub fn env(&self) -> &Env

Returns the env.

pub fn config(&self) -> &Table

Returns a reference to the config.

pub fn get_config(&self, key: &str) -> Option<&Table>

Returns a reference to the config corresponding to the key.

pub fn get_extension_config(&self, extension: &str) -> Option<&Table>

Returns a reference to the config corresponding to the extension.

pub fn parse_config<C: DeserializeOwned>( &self, key: &str, ) -> Option<Result<C, Error>>

Parses the config as an instance of C corresponding to the key.

pub fn parse_extension_config<C: DeserializeOwned>( &self, extension: &str, ) -> Option<Result<C, Error>>

Parses the config as an instance of C corresponding to the extension.

pub fn data(&self) -> &T

Returns a reference to the data.

pub fn data_mut(&mut self) -> &mut T

Returns a mutable reference to the data.

pub fn listeners(&self) -> Vec<(ServerTag, SocketAddr)>

Returns a list of listeners.

impl State

pub fn shared() -> &'static Self

Returns a reference to the shared state.

pub fn encrypt_password(config: &Table) -> Option<Cow<'_, str>>

Encrypts the password in the config.

pub fn decrypt_password(config: &Table) -> Option<Cow<'_, str>>

Decrypts the password in the config.

pub fn format_authority(config: &Table, default_port: Option<u16>) -> String

Formats the authority in the config. An authority can contain a username, password, host, and port number, which is formated as {username}:{password}@{host}:{port}.

Trait Implementations

impl<T: Clone> Clone for State<T>

fn clone(&self) -> State<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for State<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for State<T>

fn default() -> Self

Returns the “default value” for a type.