Struct Context

pub struct Context<R: Runtime + ?Sized> {
    pub cli: <R as RuntimeDef>::Cli,
    pub conf: <R as RuntimeDef>::Conf,
    pub conf_path: PathBuf,
    pub env: Box<dyn Env<<R as RuntimeDef>::Cli>>,
    pub emitter: Option<EventEmitter>,
    /* private fields */
}

Runtime execution context

Fields

cli: <R as RuntimeDef>::Cli

Command line parameters

conf: <R as RuntimeDef>::Conf

Configuration read from the configuration file

conf_path: PathBuf

Configuration file path

env: Box<dyn Env<<R as RuntimeDef>::Cli>>

Environment instance

emitter: Option<EventEmitter>

Event emitter, available when Runtime::MODE == RuntimeMode::Server and command != Command::Deploy

Implementations

impl<R> Context<R>

where R: Runtime + ?Sized, <R as RuntimeDef>::Cli: 'static,

pub fn try_new() -> Result<Self>

Create a new instance with a default environment configuration

pub fn try_with<E>(env: E) -> Result<Self>

where E: Env<<R as RuntimeDef>::Cli> + 'static,

Create a new instance with provided environment configuration

pub fn read_config<P: AsRef<Path>>(path: P) -> Result<<R as RuntimeDef>::Conf>

Read configuration from file

pub fn write_config<P: AsRef<Path>>( conf: &<R as RuntimeDef>::Conf, path: P, ) -> Result<()>

Write configuration to file

pub fn control(&self) -> RuntimeControl

Return a runtime control object

impl<R> Context<R>

where R: Runtime + ?Sized, <R as RuntimeDef>::Cli: 'static,

pub fn command<'a, H, T, Fut>(&mut self, handler: H) -> ProcessIdResponse<'a>

where H: FnOnce(RunCommandContext) -> Fut + 'static, T: Serialize, Fut: Future<Output = Result<T, Error>> + 'a,