Struct Ctx 

pub struct Ctx<'a> {
    pub platform: &'a dyn Platform,
    pub out: &'a mut dyn Write,
    pub err: &'a mut dyn Write,
    pub input: &'a mut dyn BufRead,
    pub globals: Globals,
    /* private fields */
}

A run: the platform, the outputs and the configuration, read only when a command needs it.

Fields

platform: &'a dyn Platform

out: &'a mut dyn Write

err: &'a mut dyn Write

input: &'a mut dyn BufRead

globals: Globals

Implementations

impl<'a> Ctx<'a>

pub fn new( platform: &'a dyn Platform, out: &'a mut dyn Write, err: &'a mut dyn Write, input: &'a mut dyn BufRead, globals: Globals, ) -> Ctx<'a>

pub fn env(&self, name: &str) -> Option<String>

pub fn config_path(&self) -> Result<PathBuf, CliError>

The path of config.yml.

pub fn select_profile(&mut self, name: Option<String>)

Makes name the profile the next calls use, as --profile would.

pub fn load_config(&self) -> Result<ConfigFile, CliError>

The profiles file (empty if it does not exist yet).

pub fn save_config(&self, file: &ConfigFile) -> Result<(), CliError>

pub fn settings(&mut self) -> Result<&Effective, CliError>

The effective configuration: variables, chosen profile and built-in values.

pub fn json_chosen(&mut self) -> bool

true when the person chose json (on the command line, in the environment or in the profile), and not when it is only the built-in value: only then does the error come out as the server’s ErrorResponse.

pub fn format(&mut self) -> Result<Format, CliError>

pub fn api_client(&mut self) -> Result<Client, CliError>

The client API client (with the profile’s token).

pub fn ops_client(&mut self, attempts: Option<u32>) -> Result<Client, CliError>

The operations API client: no token. attempts overrides the profile’s max-attempts.

pub fn say(&mut self, text: &str) -> Result<(), CliError>

Writes a line to standard output.

pub fn confirm(&mut self, question: &str) -> Result<bool, CliError>

Asks [y/N] on a terminal. Off a terminal it does not ask: the caller requires --yes.

pub fn require_confirmation( &mut self, yes: bool, question: &str, ) -> Result<(), CliError>

Asks for confirmation of an action that deletes: --yes is enough; without it, it asks on a terminal and refuses (code 2) off one.