Struct std::io::Stdout

1.0.0 · source ·

pub struct Stdout { /* private fields */ }

Expand description

A handle to the global standard output stream of the current process.

Each handle shares a global buffer of data to be written to the standard output stream. Access is also synchronized via a lock and explicit control over locking is available via the lock method.

Created by the io::stdout method.

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.

Implementations

source

impl Stdout

source

pub fn lock(&self) -> StdoutLock<'static>iNotable traits for StdoutLock<'_>impl Write for StdoutLock<'_>

Locks this handle to the standard output stream, returning a writable guard.

The lock is released when the returned lock goes out of scope. The returned guard also implements the Write trait for writing data.

Examples

use std::io::{self, Write};
fn main() -> io::Result<()> {
 let mut stdout = io::stdout().lock();
 stdout.write_all(b"hello world")?;
 Ok(())
}

Run

Trait Implementations

1.63.0 · source

impl AsFd for Stdout

source

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

Available on Unix only.

Borrows the file descriptor. Read more

1.63.0 · source

impl AsHandle for Stdout

Available on Windows only.

source

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

Borrows the handle. Read more

1.21.0 · source

impl AsRawFd for Stdout

source

fn as_raw_fd(&self) -> RawFd

Available on Unix only.

Extracts the raw file descriptor. Read more

1.21.0 · source

impl AsRawHandle for Stdout

Available on Windows only.

source

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle. Read more

1.16.0 · source

impl Debug for Stdout

source

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

Formats the value using the given formatter. Read more

1.48.0 · source

impl Write for &Stdout

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, args: Arguments<'_>) -> Result<()>

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

source

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

Creates a "by reference" adapter for this instance of Write. Read more

source

impl Write for Stdout

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, args: Arguments<'_>) -> Result<()>

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

source

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

Creates a "by reference" adapter for this instance of Write. Read more