Struct nameless::InteractiveTextStream
source · pub struct InteractiveTextStream { /* private fields */ }
Expand description
An InteractiveTextStream
implements Read
and Write
as is meant
to be used with interactive streams.
The primary way to construct an InteractiveTextStream
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:
oraccept:
, 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§
source§impl InteractiveTextStream
impl InteractiveTextStream
sourcepub fn write_pseudonym(&mut self, pseudonym: &Pseudonym) -> Result<()>
pub fn write_pseudonym(&mut self, pseudonym: &Pseudonym) -> Result<()>
Write the given Pseudonym
to the output stream.
Trait Implementations§
source§impl Bufferable for InteractiveTextStream
impl Bufferable for InteractiveTextStream
source§impl Debug for InteractiveTextStream
impl Debug for InteractiveTextStream
source§impl DuplexTerminal for InteractiveTextStream
impl DuplexTerminal for InteractiveTextStream
source§fn is_terminal(&self) -> bool
fn is_terminal(&self) -> bool
Test whether both the input stream and output streams are connected to
terminals. Read more
source§impl Read for InteractiveTextStream
impl Read for InteractiveTextStream
source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
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. Read more
source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
Like
read
, except that it reads into a slice of buffers. Read moresource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
Read all bytes until EOF in this source, placing them into
buf
. Read moresource§fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
Read all bytes until EOF in this source, appending them to
buf
. Read moresource§fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
Read the exact number of bytes required to fill
buf
. Read moresource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
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. Read more
source§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
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
. Read more1.0.0 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read
. Read moresource§impl ReadLayered for InteractiveTextStream
impl ReadLayered for InteractiveTextStream
source§fn read_with_status(&mut self, buf: &mut [u8]) -> Result<(usize, Status)>
fn read_with_status(&mut self, buf: &mut [u8]) -> Result<(usize, Status)>
Like
Read::read
, but also returns a Status
.source§fn read_vectored_with_status(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<(usize, Status)>
fn read_vectored_with_status( &mut self, bufs: &mut [IoSliceMut<'_>] ) -> Result<(usize, Status)>
Like
Read::read_vectored
, but also returns a Status
.source§fn read_exact_using_status(&mut self, buf: &mut [u8]) -> Result<Status, Error>
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.source§fn minimum_buffer_size(&self) -> usize
fn minimum_buffer_size(&self) -> usize
Some streams require a buffer of at least a certain size.
source§impl ReadStr for InteractiveTextStream
impl ReadStr for InteractiveTextStream
source§impl ReadStrLayered for InteractiveTextStream
impl ReadStrLayered for InteractiveTextStream
source§impl ReadTerminal for InteractiveTextStream
impl ReadTerminal for InteractiveTextStream
source§fn is_line_by_line(&self) -> bool
fn is_line_by_line(&self) -> bool
Test whether the input is being sent a line at a time.
source§fn is_input_terminal(&self) -> bool
fn is_input_terminal(&self) -> bool
Test whether the input is connected to a terminal. Read more
source§impl Write for InteractiveTextStream
impl Write for InteractiveTextStream
source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)source§fn write_all(&mut self, buf: &[u8]) -> Result<()>
fn write_all(&mut self, buf: &[u8]) -> Result<()>
Attempts to write an entire buffer into this writer. Read more
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>
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. Read more
source§impl WriteLayered for InteractiveTextStream
impl WriteLayered for InteractiveTextStream
source§impl WriteStr for InteractiveTextStream
impl WriteStr for InteractiveTextStream
source§impl WriteTerminal for InteractiveTextStream
impl WriteTerminal for InteractiveTextStream
source§fn color_support(&self) -> TerminalColorSupport
fn color_support(&self) -> TerminalColorSupport
Test whether this output stream supports color control codes.
source§fn color_preference(&self) -> bool
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.source§fn is_output_terminal(&self) -> bool
fn is_output_terminal(&self) -> bool
Test whether the output is connected to a terminal. Read more
source§fn color_default(&self) -> bool
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 InteractiveTextStream
impl Terminal for InteractiveTextStream
Auto Trait Implementations§
impl Freeze for InteractiveTextStream
impl !RefUnwindSafe for InteractiveTextStream
impl Send for InteractiveTextStream
impl Sync for InteractiveTextStream
impl Unpin for InteractiveTextStream
impl !UnwindSafe for InteractiveTextStream
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> GetSetFdFlags for T
impl<T> GetSetFdFlags for T
source§fn get_fd_flags(&self) -> Result<FdFlags, Error>where
T: AsFilelike,
fn get_fd_flags(&self) -> Result<FdFlags, Error>where
T: AsFilelike,
Query the “status” flags for the
self
file descriptor.source§fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>where
T: AsFilelike,
fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>where
T: AsFilelike,
source§fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>where
T: AsFilelike,
fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>where
T: AsFilelike,
Set the “status” flags for the
self
file descriptor. Read more