Enum Environment

pub enum Environment {
    Host(Host),
    Distrobox(Distrobox),
    Toolbx(Toolbx),
}

All the execution environments known to the applicaiton.

Variants

Host(Host)

The host system

Distrobox(Distrobox)

A distrobox instance

Toolbx(Toolbx)

A toolbx instance

Implementations

impl Environment

pub async fn output_of( &self, cmd: CommandLine, ) -> Result<String, ExecutionError>

Execute a command in this environment and collect stdout, if possible.

Executes cmd inside this env, collecting all output. If execution finishes successfully, the stdout is returned as String. Otherwise, an ExecutionError is returned instead.

The ExecutionError type takes care of a lot of boilerplate code that is otherwise necessary to detect specific error conditions caused by different environments (because they can produce different output for similar/identical error conditions).

Refer to OutputMatcher for added convenience when trying to recover from a NonZero error.

Test integration

In conjunction with the Mock type, this function allows replaying the output of called commands. Use the quick_test! macro to simulate command outputs inside tests.

pub fn to_json(&self) -> String

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

Start an environment manually.

This is usually done automatically when creating environment instances through their constructors. For some environments, this is a no-op.

Trait Implementations

impl Debug for Environment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Environment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Environment

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

Formats the value using the given formatter.

impl From<Distrobox> for Environment

fn from(value: Distrobox) -> Self

Converts to this type from the input type.

impl From<Host> for Environment

fn from(value: Host) -> Self

Converts to this type from the input type.

impl From<Toolbx> for Environment

fn from(value: Toolbx) -> Self

Converts to this type from the input type.

impl FromStr for Environment

type Err = SerializationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl IsEnvironment for Environment

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 Environment

fn cmp(&self, other: &Environment) -> 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 Environment

fn eq(&self, other: &Environment) -> 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 Environment

fn partial_cmp(&self, other: &Environment) -> 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 Environment

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 Environment

impl StructuralPartialEq for Environment