Enum boxxy::ctrl::Interface

pub enum Interface {
    Fancy((Stdin, Stdout, Editor<CmdCompleter>)),
    Stdio(BufStream<RW<Stdin, Stdout>>),
    File(BufStream<RW<File, File>>),
    RWPair(BufStream<RW<Box<R>, Box<W>>>),
    Tls(Box<BufStream<OwnedTlsStream>>),
    Ipc(BufStream<UnixStream>),
    Dummy(Vec<u8>),
}

The interface that the Shell uses.

Variants

Fancy((Stdin, Stdout, Editor<CmdCompleter>))Stdio(BufStream<RW<Stdin, Stdout>>)File(BufStream<RW<File, File>>)RWPair(BufStream<RW<Box<R>, Box<W>>>)Tls(Box<BufStream<OwnedTlsStream>>)Ipc(BufStream<UnixStream>)Dummy(Vec<u8>)

Methods

impl Interface

Important traits for Interface

impl Read for Interfaceimpl Write for Interface

pub fn default(toolbox: &Arc<Mutex<Toolbox>>) -> Interface

Important traits for Interface

impl Read for Interfaceimpl Write for Interface

pub fn fancy(toolbox: Arc<Mutex<Toolbox>>) -> Interface

Important traits for Interface

impl Read for Interfaceimpl Write for Interface

pub fn stdio() -> Interface

Important traits for Interface

impl Read for Interfaceimpl Write for Interface

pub fn file(input: Option<File>, output: Option<File>) -> Interface

Important traits for Interface

impl Read for Interfaceimpl Write for Interface

pub fn rw_pair(input: Box<R>, output: Box<W>) -> Interface

Important traits for Interface

impl Read for Interfaceimpl Write for Interface

pub fn dummy() -> Interface

pub fn readline_raw<RW: BufRead + Write>(     prompt: &str,     x: &mut RW ) -> Result<String, PromptError>

pub fn readline(&mut self, prompt: &str) -> Result<String, PromptError>

pub fn add_history_entry(&mut self, line: &str)

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

Trait Implementations

impl Debug for Interface

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

Formats the value using the given formatter.

impl Read for Interface

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, appending them to 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>

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

🔬 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 Interface

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.