Struct ShellIO

pub struct ShellIO { /* private fields */ }

Input / Output for shell execution

Implementations

impl ShellIO

pub fn new<I, O>(input: I, output: O) -> ShellIO

where I: Read + Send + 'static, O: Write + Send + 'static,

Create a new Shell I/O wrapping provided Input and Output

pub fn new_io<T>(io: T) -> ShellIO

where T: Read + Write + Send + 'static,

Create a new Shell I/O wrapping provided Read/Write io

Examples found in repository

examples/socket.rs (line 48)

fn main() {
    let map = Arc::new(Mutex::new(HashMap::new()));

    let mut shell = Shell::new(map);

    shell.new_command(&"put", &"Insert a value", 2, |_, map, args| {
        map.lock().unwrap().insert(usize::from_str(args[0])?, args[1].to_string());
        Ok(())
    });
    shell.new_command("get", "Get a value", 1, |io, map, args| {
        match map.lock().unwrap().get(&usize::from_str(args[0])?) {
            Some(val) => writeln!(io, "{}", val).unwrap(),
            None => writeln!(io, "Not found").unwrap()
        };
        Ok(())
    });
    shell.new_command("remove", "Remove a value", 1, |_, map, args| {
        map.lock().unwrap().remove(&usize::from_str(args[0])?);
        Ok(())
    });
    shell.new_command("list", "List all values", 0, |io, map, _| {
        for (k, v) in &*map.lock().unwrap() {
            writeln!(io, "{} = {}", k, v).unwrap();
        }
        Ok(())
    });
    shell.new_command_noargs("clear", "Clear all values", |_, map| {
        map.lock().unwrap().clear();
        Ok(())
    });

    let serv = TcpListener::bind("0.0.0.0:1234").expect("Cannot open socket");
    for sock in serv.incoming() {
        let sock = sock.unwrap();
        let mut shell = shell.clone();
        let mut io = ShellIO::new_io(sock);
        thread::spawn(move || shell.run_loop(&mut io));
    }
}

Trait Implementations

impl Clone for ShellIO

fn clone(&self) -> ShellIO

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ShellIO

fn default() -> Self

Returns the “default value” for a type.

impl Read for ShellIO

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.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

impl Write for ShellIO

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

Writes a buffer into this writer, returning how many bytes were written.

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

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

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

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

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.