Struct StdoutLock

pub struct StdoutLock<'a> { /* private fields */ }

A locked reference to the Stdout handle.

This handle implements the Write trait, and is constructed via the Stdout::lock method. See its documentation for more.

By default, the handle is line-buffered when connected to a terminal, meaning it flushes automatically when a newline (\n) is encountered. For immediate output, you can manually call the flush method. When the handle goes out of scope, the buffer is automatically flushed.

Note: Windows Portability Considerations

When operating in a console, the Windows implementation of this stream does not support non-UTF-8 byte sequences. Attempting to write bytes that are not valid UTF-8 will return an error.

In a process with a detached console, such as one using #![windows_subsystem = "windows"], or in a child process spawned from such a process, the contained handle will be null. In such cases, the standard library’s Read and Write will do nothing and silently succeed. All other I/O operations, via the standard library or via raw Windows API calls, will fail.

Trait Implementations

impl<'a> AsFd for StdoutLock<'a>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<'a> AsRawFd for StdoutLock<'a>

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Debug for StdoutLock<'_>

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

Formats the value using the given formatter.

impl IsTerminal for StdoutLock<'_>

fn is_terminal(&self) -> bool

Returns true if the descriptor/handle refers to a terminal/tty.

impl Write for StdoutLock<'_>

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

Writes a buffer into this writer, returning how many bytes were written.

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

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 flush(&mut self) -> Result<(), Error>

Flushes 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 writer.

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

🔬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<(), Error>

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 RefUnwindSafe for StdoutLock<'_>

impl UnwindSafe for StdoutLock<'_>