Struct knightrs::environment::Builder

pub struct Builder<'i, 'o, 'c> { /* fields omitted */ }

A Builder for the Environment struct.

Implementations

impl<'i, 'o, 'c> Builder<'i, 'o, 'c>

#[must_use = "creating a builder does nothing by itself."]

pub fn new() -> Self

Creates a new, default Builder.

#[must_use = "assigning a capacity does nothing without calling 'build'."]

pub fn capacity(self, capacity: usize) -> Self

Sets the initial starting capacity for the set of Variables.

If not set, an (unspecified) default capacity is used.

#[must_use = "assigning to stdin does nothing without calling 'build'."]

pub fn stdin(self, stdin: &'i mut dyn Read) -> Self

Sets the stdin for the Environment.

This defaults to the stdin of the process.

#[must_use = "assigning to stdout does nothing without calling 'build'."]

pub fn stdout(self, stdout: &'o mut dyn Write) -> Self

Sets the stdout for the Environment.

This defaults to the stdout of the process.

#[must_use = "assigning a 'system' does nothing without calling 'build'."]

pub fn system(
    self,
    system: &'c mut dyn FnMut(&str) -> Result<Text, Error>
) -> Self

Explicitly sets what should happen when the “system” (`) function is called.

The default value is to simply send the command to sh (ie "sh", "-c", "command")

#[must_use = "disabling the system command to does nothing without calling 'build'."]

pub fn disable_system(self) -> Self

Disables the “system” (`) command entirely.

When this is enabled, all calls to ` will return errors.

#[must_use = "Simply calling `build` does nothing on its own."]

pub fn build(self) -> Environment<'i, 'o, 'c>

Creates a new Environment with all the supplied options.

Any options that have not been explicitly set will have their default values used.

Trait Implementations

impl<'i, 'o, 'c> Default for Builder<'i, 'o, 'c>

fn default() -> Builder<'i, 'o, 'c>

Returns the “default value” for a type.