Struct iroh_docs::cli::ConsoleEnv

pub struct ConsoleEnv(/* private fields */);

Available on crate feature cli only.

Environment for CLI and REPL

This is cheaply cloneable and has interior mutability. If not running in the console environment, Self::set_doc and Self::set_author will lead to an error, as changing the environment is only supported within the console.

Implementations

impl ConsoleEnv

pub async fn for_console( iroh_data_dir: PathBuf, authors: &Client ) -> Result<Self>

Read from environment variables and the console config file.

pub async fn for_cli(iroh_data_dir: PathBuf, authors: &Client) -> Result<Self>

Read only from environment variables.

pub fn iroh_data_dir(&self) -> PathBuf

Return the iroh data directory

pub fn doc(&self, arg: Option<NamespaceId>) -> Result<NamespaceId>

Get the active document.

pub fn author(&self) -> AuthorId

Get the active author.

This is either the node’s default author, or in the console optionally the author manually switched to.

Trait Implementations

impl Clone for ConsoleEnv

fn clone(&self) -> ConsoleEnv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConsoleEnv

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

Formats the value using the given formatter.