Struct StdoutLock

#[must_use = "if unused stdout will immediately unlock"]
pub struct StdoutLock<'a> { pub(in ::io::stdio) inner: ReentrantLockGuard<'a, RefCell<LineWriter<StdoutRaw>>> }

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.

Fields

inner: ReentrantLockGuard<'a, RefCell<LineWriter<StdoutRaw>>>

Trait Implementations

impl CopyWrite for StdoutLock<'_>

fn properties(&self) -> CopyParams

impl Debug for StdoutLock<'_>

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

impl IsTerminal for StdoutLock<'_>

fn is_terminal(&self) -> bool

impl RefUnwindSafe for StdoutLock<'_>

impl StdioExt for StdoutLock<'_>

fn set_handle<T: Into<OwnedHandle>>(&mut self, handle: Option<T>) -> Result<()>
fn replace_handle<T: Into<OwnedHandle>>(&mut self, replace_with: T) -> Result<Option<BorrowedHandle<'static>>>
fn take_handle(&mut self) -> Result<Option<BorrowedHandle<'static>>>

impl StdioExt for StdoutLock<'_>

fn set_fd<T: Into<OwnedFd>>(&mut self, fd: T) -> Result<()>
fn take_fd(&mut self) -> Result<OwnedFd>
fn replace_fd<T: Into<OwnedFd>>(&mut self, replace_with: T) -> Result<OwnedFd>

impl UnwindSafe for StdoutLock<'_>

impl Write for StdoutLock<'_>

fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>
fn is_write_vectored(&self) -> bool
fn flush(&mut self) -> Result<()>
fn write_all(&mut self, buf: &[u8]) -> Result<()>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>

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

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

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

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

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

fn as_raw_fd(&self) -> RawFd

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

fn as_raw_handle(&self) -> RawHandle

Auto Trait Implementations

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

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

impl<'a> Freeze for StdoutLock<'a>

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

impl<'a> UnsafeUnpin for StdoutLock<'a>

Blanket Implementations

impl<T> Any for StdoutLock<'a> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for StdoutLock<'a> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for StdoutLock<'a> where T: ?Sized,

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

impl<T> From<T> for StdoutLock<'a>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> SizeHint for StdoutLock<'a> where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

impl<T> SizedTypeProperties for StdoutLock<'a>

impl<T, U> Into<U> for StdoutLock<'a> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

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

impl<T, U> TryFrom<U> for StdoutLock<'a> where U: Into<T>,

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

impl<T, U> TryInto<U> for StdoutLock<'a> where U: TryFrom<T>,

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