Shell

Struct Shell 

Source
pub struct Shell { /* private fields */ }
Expand description

Represents the Shell that parses the user input into a command and executes it

Implementations§

Source§

impl Shell

Source

pub fn new(prefix: Option<&str>, available_commands: Vec<Command>) -> Self

Creates a new Shell

§Arguments
  • prefix - The prefix that should be printed before the user inputs a command
  • available_commands - A list of commands that are executable
Source

pub fn process(&self) -> Result<(), CommandError>

Processes a whole command

This includes:

  • Reading the command with arguments from STDIN
  • Execute the command
  • Return the result
§Returns

This function returns Ok(()) if everything went fine. Otherwise it will return a CommandError which represents the error hat occured

Auto Trait Implementations§

§

impl Freeze for Shell

§

impl !RefUnwindSafe for Shell

§

impl !Send for Shell

§

impl !Sync for Shell

§

impl Unpin for Shell

§

impl !UnwindSafe for Shell

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.