Struct HookContext 

pub struct HookContext {
    pub data: HashMap<String, Value>,
    pub cwd: Option<PathBuf>,
    pub view_root: Option<PathBuf>,
    pub theme: Option<String>,
}

Context provided to plugins when a hook is invoked.

Fields

data: HashMap<String, Value>

Additional data passed to the hook.

cwd: Option<PathBuf>

Current working directory.

view_root: Option<PathBuf>

Current view root (drill-down location).

theme: Option<String>

The colour theme’s name.

Implementations

impl HookContext

pub fn new() -> Self

Create a new empty context.

pub fn set( &mut self, key: impl Into<String>, value: impl Into<Value>, ) -> &mut Self

Set a value in the context.

pub fn get(&self, key: &str) -> Option<&Value>

Get a value from the context.

pub fn with_cwd(self, cwd: PathBuf) -> Self

Set the current working directory.

pub fn with_view_root(self, view_root: PathBuf) -> Self

Set the view root.

pub fn with_theme(self, theme: impl Into<String>) -> Self

Set the theme.

Trait Implementations

impl Clone for HookContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookContext

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

Formats the value using the given formatter.

impl Default for HookContext

fn default() -> Self

Returns the “default value” for a type.