Struct io_streams::StreamWriter [−][src]
pub struct StreamWriter { /* fields omitted */ }
An unbuffered and unlocked output byte stream, implementing Write
,
abstracted over the destination of the output.
It primarily consists of a single file handle, and also contains any resources needed to safely hold the file handle live.
Since it is unbuffered, and since many destinations have high per-call
overhead, it is often beneficial to wrap this in a BufWriter
or
LineWriter
.
Implementations
impl StreamWriter
[src]
impl StreamWriter
[src]pub fn stdout() -> Result<Self>
[src]
pub fn stdout() -> Result<Self>
[src]Write to standard output.
Unlike std::io::stdout
, this stdout
returns a stream which is
unbuffered and unlocked.
Since it is unbuffered, it is often beneficial to wrap the resulting
StreamWriter
in a [BufWriter
] or [LineWriter
].
This acquires a std::io::StdoutLock
(in a non-recursive way) to
prevent accesses to std::io::Stdout
while this is live, and fails if
a StreamWriter
or StreamDuplexer
for standard output already
exists.
#[must_use]pub fn file<Filelike: IntoUnsafeFile + Read + Write + Seek>(
filelike: Filelike
) -> Self
[src]
#[must_use]pub fn file<Filelike: IntoUnsafeFile + Read + Write + Seek>(
filelike: Filelike
) -> Self
[src]Write to an open file, taking ownership of it.
This method can be passed a std::fs::File
or similar File
types.
#[must_use]pub fn tcp_stream<Socketlike: IntoUnsafeSocket>(socketlike: Socketlike) -> Self
[src]
#[must_use]pub fn tcp_stream<Socketlike: IntoUnsafeSocket>(socketlike: Socketlike) -> Self
[src]Write to an open TCP stream, taking ownership of it.
This method can be passed a std::net::TcpStream
or similar
TcpStream
types.
#[must_use]pub fn pipe_writer(pipe_writer: PipeWriter) -> Self
[src]
#[must_use]pub fn pipe_writer(pipe_writer: PipeWriter) -> Self
[src]Write to the writing end of an open pipe, taking ownership of it.
pub fn write_to_command(command: Command) -> Result<Self>
[src]
pub fn write_to_command(command: Command) -> Result<Self>
[src]Spawn the given command and write to its standard input. Its standard
output is redirected to Stdio::null()
.
#[must_use]pub fn child_stdin(child_stdin: ChildStdin) -> Self
[src]
#[must_use]pub fn child_stdin(child_stdin: ChildStdin) -> Self
[src]Write to the given child standard input, taking ownership of it.
pub fn piped_thread(boxed_write: Box<dyn Write + Send>) -> Result<Self>
[src]
pub fn piped_thread(boxed_write: Box<dyn Write + Send>) -> Result<Self>
[src]Write to a boxed Write
implementation, taking ownership of it. This
works by creating a new thread to read the data through a pipe and
write it.
Writes to the pipe aren’t synchronous with writes to the boxed Write
implementation. To ensure data is flushed all the way through the
thread and into the boxed Write
implementation, call flush
()
,
which synchronizes with the thread to ensure that is has completed
writing all pending output.
Trait Implementations
impl AsRawHandleOrSocket for StreamWriter
[src]
impl AsRawHandleOrSocket for StreamWriter
[src]fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket
[src]
fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket
[src]Like AsRawHandle::as_raw_handle
and AsRawSocket::as_raw_socket
but can return either type. Read more
impl Debug for StreamWriter
[src]
impl Debug for StreamWriter
[src]impl Write for StreamWriter
[src]
impl Write for StreamWriter
[src]fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]Write a buffer into this writer, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
fn flush(&mut self) -> Result<()>
[src]Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn is_write_vectored(&self) -> bool
[src]
fn is_write_vectored(&self) -> bool
[src]can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<()>
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<()>
[src]Attempts to write an entire buffer into this writer. Read more
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>
[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>
[src]write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
impl OwnsRaw for StreamWriter
[src]
Auto Trait Implementations
impl !RefUnwindSafe for StreamWriter
impl Send for StreamWriter
impl !Sync for StreamWriter
impl Unpin for StreamWriter
impl !UnwindSafe for StreamWriter
Blanket Implementations
impl<T> AsUnsafeHandle for T where
T: AsRawHandleOrSocket + OwnsRaw,
[src]
impl<T> AsUnsafeHandle for T where
T: AsRawHandleOrSocket + OwnsRaw,
[src]pub fn as_unsafe_handle(&self) -> UnsafeHandle
[src]
pub fn as_unsafe_handle(&self) -> UnsafeHandle
[src]Return the contained unsafe handle.
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more