Struct nameless::InteractiveByteStream

pub struct InteractiveByteStream { /* private fields */ }

An InteractiveByteStream implements Read and Write as is meant to be used with interactive streams.

The primary way to construct an InteractiveByteStream is to use it as a type in a kommand argument or clap_derive struct. Command-line arguments will then be automatically converted into input streams. Currently supported syntaxes include:

• Names starting with connect: or accept:, which are interpreted as socket addresses to connect to or accept from. Socket addresses may contain host:port pairs or, on platforms which support it, filesystem paths to Unix-domain sockets.
• “-” is interpreted as the pair (stdin, stdout).
• “(…)” runs a command with pipes to and from the child process’ (stdin, stdout), on platforms whch support it.

Implementations

impl InteractiveByteStream

pub fn pseudonym(&self) -> Pseudonym

Return a Pseudonym which encapsulates this stream’s name (typically its filesystem path or its URL). This allows it to be written to an InteractiveByteStream while otherwise remaining entirely opaque.

Trait Implementations

impl Bufferable for InteractiveByteStream

fn abandon(&mut self)

Close the resource and abandon any pending buffered contents or errors.

fn suggested_buffer_size(&self) -> usize

A suggested size, in bytes, for buffering for performance.

impl Debug for InteractiveByteStream

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

Formats the value using the given formatter.

impl DuplexTerminal for InteractiveByteStream

fn is_terminal(&self) -> bool

Test whether both the input stream and output streams are connected to terminals.

impl Read for InteractiveByteStream

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>

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>

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

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

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 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)

Read 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 ReadLayered for InteractiveByteStream

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

Like Read::read, but also returns a Status.

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

Like Read::read_vectored, but also returns a Status.

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

Like Read::read_exact, but uses read_with_status to avoid performing an extra read at the end.

fn minimum_buffer_size(&self) -> usize

Some streams require a buffer of at least a certain size.

impl ReadTerminal for InteractiveByteStream

fn is_line_by_line(&self) -> bool

Test whether the input is being sent a line at a time.

fn is_input_terminal(&self) -> bool

Test whether the input is connected to a terminal.

impl Write for InteractiveByteStream

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

Write a buffer into this writer, 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_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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<()>

Attempts to write an entire buffer into this writer.

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

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

Attempts to write multiple buffers into this writer.

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

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.

impl WriteLayered for InteractiveByteStream

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

Flush any buffers and declare the end of the stream. Subsequent writes will fail.

fn flush_with_status(&mut self, status: Status) -> Result<(), Error>

Like Write::flush, but has a status parameter describing the future of the stream:

impl WriteTerminal for InteractiveByteStream

fn color_support(&self) -> TerminalColorSupport

Test whether this output stream supports color control codes.

fn color_preference(&self) -> bool

Test whether the user has indicated a preference for color output by default. Respects the NO_COLOR environment variable where applicable.

fn is_output_terminal(&self) -> bool

Test whether the output is connected to a terminal.

fn color_default(&self) -> bool

Test whether color should be used on this terminal by default. This includes both whether color is supported and whether the user has not indicated a preference otherwise.

impl Duplex for InteractiveByteStream

impl Terminal for InteractiveByteStream