Struct std::io::StdoutLock

1.0.0 · source ·
pub struct StdoutLock<'a> {
    inner: ReentrantMutexGuard<'a, RefCell<LineWriter<StdoutRaw>>>,
}
Expand description

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.

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.

Fields§

§inner: ReentrantMutexGuard<'a, RefCell<LineWriter<StdoutRaw>>>

Trait Implementations§

1.63.0 · source§

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

source§

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

Borrows the file descriptor. Read more
1.63.0 · source§

impl<'a> AsHandle for StdoutLock<'a>

Available on Windows only.
source§

fn as_handle(&self) -> BorrowedHandle<'_>

Borrows the handle. Read more
1.35.0 · source§

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

source§

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more
1.35.0 · source§

impl<'a> AsRawHandle for StdoutLock<'a>

Available on Windows only.
source§

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle. Read more
source§

impl CopyWrite for StdoutLock<'_>

source§

fn properties(&self) -> CopyParams

Extracts the file descriptor and hints/metadata, delegating through wrappers if necessary.
1.16.0 · source§

impl Debug for StdoutLock<'_>

source§

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

Formats the value using the given formatter. Read more
1.70.0 · source§

impl IsTerminal for StdoutLock<'_>

source§

fn is_terminal(&self) -> bool

Returns true if the descriptor/handle refers to a terminal/tty. Read more
source§

impl Write for StdoutLock<'_>

source§

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

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

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

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector #69941)
Determines if this Writer has an efficient write_vectored implementation. Read more
source§

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

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

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

🔬This is a nightly-only experimental API. (write_all_vectored #70436)
Attempts to write multiple buffers into this writer. Read more
source§

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

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

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more
source§

impl Sealed for StdoutLock<'_>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for StdoutLock<'a>

§

impl<'a> !Send for StdoutLock<'a>

§

impl<'a> Sync for StdoutLock<'a>

§

impl<'a> Unpin for StdoutLock<'a>

§

impl<'a> UnwindSafe for StdoutLock<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.