Struct io_streams::StreamWriter[][src]

pub struct StreamWriter { /* fields omitted */ }
Expand description

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

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.

Write to an open file, taking ownership of it.

This method can be passed a std::fs::File or similar File types.

Write to an open TCP stream, taking ownership of it.

This method can be passed a std::net::TcpStream or similar TcpStream types.

Write to an open Unix-domain stream, taking ownership of it.

Write to the writing end of an open pipe, taking ownership of it.

Spawn the given command and write to its standard input. Its standard output is redirected to Stdio::null().

Write to the given child standard input, taking ownership of it.

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.

Write to the null device, which ignores all data.

Trait Implementations

Borrows the file descriptor. Read more

Extracts the raw file descriptor. Read more

Formats the value using the given formatter. Read more

Write a buffer into this writer, returning how many bytes were written. Read more

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

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

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

Determines if this Writer has an efficient write_vectored implementation. Read more

Attempts to write an entire buffer into this writer. Read more

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

Attempts to write multiple buffers into this writer. Read more

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

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Borrows the reference. Read more

Return a borrowing view of a resource which dereferences to a &Target or &mut Target. Read more

Extracts the grip.

Extracts the raw grip.

Borrows the reference.

Return a borrowing view of a resource which dereferences to a &Target or &mut Target. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Announce the expected access pattern of the data at the given offset.

Allocate space in the file, increasing the file size as needed, and ensuring that there are no holes under the given range. Read more

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

Read the exact number of bytes required to fill buf. Read more

Reads a number of bytes starting from a given offset. Read more

Reads the exact number of byte required to fill buf from the given offset. Read more

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

Is to read_vectored what read_at is to read.

Determines if this Reader has an efficient read_vectored_at implementation.

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

Read all bytes, starting at offset, until EOF in this source, placing them into buf. Read more

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

Read all bytes, starting at offset, until EOF in this source, appending them to buf. Read more

Read bytes from the current position without advancing the current position. Read more

Write a buffer into this writer, returning how many bytes were written. Read more

Attempts to write an entire buffer into this writer. Read more

Writes a number of bytes starting from a given offset. Read more

Attempts to write an entire buffer starting from a given offset. Read more

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

Is to write_vectored what write_at is to write.

Determines if this Writer has an efficient write_vectored_at implementation.

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

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

Seek to an offset, in bytes, in a stream. Read more

Returns the current seek position from the start of the stream. Read more

Is to read_vectored what read_exact is to read.

Is to read_exact_vectored what read_exact_at is to read_exact.

Is to write_vectored what write_all is to write.

Is to write_all_vectored what write_all_at is to write_all.

Performs the conversion.

Query the “status” flags for the self file descriptor.

Create a new SetFdFlags value for use with set_fd_flags. Read more

Set the “status” flags for the self file descriptor. Read more

Performs the conversion.

Test whether the handle is readable and/or writable.

Test whether this output stream is attached to a terminal. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.