Struct boxxy::shell::Shell

pub struct Shell { /* fields omitted */ }

The struct that keeps track of the user interface.

Methods

impl Shell

fn new(toolbox: Toolbox) -> Shell

Initializes a shell. Takes a Toolbox that contains the available commands. The toolbox is also used to configure tab completion.

use boxxy::{Shell, Toolbox};

let toolbox = Toolbox::new();
let shell = Shell::new(toolbox);

fn downgrade(&mut self)

Replace the readline interface with a plain stdin/stdout interface.

use boxxy::{Shell, Toolbox};

let toolbox = Toolbox::new();
let mut shell = Shell::new(toolbox);
shell.downgrade();
shell.run();

fn hotswap(&mut self, ui: Interface)

fn pipe(&mut self) -> Option<(RawFd, RawFd, RawFd)>

fn insert<I: Into<String>>(&mut self, name: I, command: Command)

Insert a Command into the Toolbox.

use boxxy::{self, Shell, Command, Toolbox};

let toolbox = Toolbox::empty();
let mut shell = Shell::new(toolbox);
shell.insert("ls", Command::Native(boxxy::busybox::ls));

fn exec_once(&mut self, line: &str)

fn run(&mut self)

Run the input loop. This doesn't return until the shell is exited.

use boxxy::{Shell, Toolbox};

let toolbox = Toolbox::new();
let mut shell = Shell::new(toolbox);

// run the loop
shell.run();

Trait Implementations

impl Read for Shell

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API. (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Write for Shell

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.