Struct Toolbx 

pub struct Toolbx { /* private fields */ }

Implementations

impl Toolbx

pub fn new(name: Option<String>) -> Result<Toolbx, NewToolbxError>

Spawn a Toolbx container with a given name.

Checks if the toolbx container exists and starts it, if necessary. If None is given as name, will try to determine the default toolbx name and start that instead. Returns an error if unsuccessful.

pub fn start(&self) -> Result<(), StartToolbxError>

Starts a given toolbx container.

This function is automatically called by new() above and should only ever be called when creating a Toolbx object without using the constructor. This is currently the case when executing aliases in cnf, as the Toolbx instance is deserialized from the config in that case.

pub fn current() -> Result<Toolbx, CurrentToolbxError>

Get the Toolbx container currently executing CNF.

Will return an error if the current execution environment isn’t Toolbx.

pub fn default_name() -> Result<String, DefaultToolbxError>

Get the name of the default toolbx to lookup/execute commands in.

The default toolbx container name is assembled from the contents of /etc/os-release.

Trait Implementations

impl Debug for Toolbx

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Toolbx

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Toolbx

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

Formats the value using the given formatter.

impl From<Toolbx> for Environment

fn from(value: Toolbx) -> Self

Converts to this type from the input type.

impl IsEnvironment for Toolbx

type Err = Error

fn exists<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns true if the given Env is available at all.

fn execute<'life0, 'async_trait>( &'life0 self, command: CommandLine, ) -> Pin<Box<dyn Future<Output = Result<Command, Self::Err>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute a command within this environment

impl Ord for Toolbx

fn cmp(&self, other: &Toolbx) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Toolbx

fn eq(&self, other: &Toolbx) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Toolbx

fn partial_cmp(&self, other: &Toolbx) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Toolbx

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Toolbx

impl StructuralPartialEq for Toolbx