Struct terminal_io::TerminalWriter[−][src]

pub struct TerminalWriter<Inner: Write> { /* fields omitted */ }
Expand description

A wrapper around a Write which adds minimal terminal support.

Implementations

impl<Inner: Write + AsUnsafeHandle> TerminalWriter<Inner>[src]

pub fn with_handle(inner: Inner) -> Self[src]

Wrap a TerminalWriter around the given stream, autodetecting terminal properties using its AsUnsafeHandle implementation.

pub fn from(
    inner: Inner,
    is_terminal: bool,
    color_support: TerminalColorSupport,
    color_preference: bool
) -> Self[src]

Wrap a TerminalWriter around the given stream, using the given terminal properties.

impl<Inner: Write> TerminalWriter<Inner>[src]

pub fn generic(inner: Inner) -> Self[src]

Wrap a TerminalWriter around the given stream, using conservative terminal properties.

pub fn into_inner(self) -> Inner[src]

Consume self and return the inner stream.

Trait Implementations

impl<Inner: Write + AsRawFd> AsRawFd for TerminalWriter<Inner>[src]

fn as_raw_fd(&self) -> RawFd[src]

Extracts the raw file descriptor. Read more

impl<Inner: Debug + Write> Debug for TerminalWriter<Inner>[src]

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

Formats the value using the given formatter. Read more

impl<Inner: Write> Write for TerminalWriter<Inner>[src]

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

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

fn flush(&mut self) -> Result<()>[src]

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

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

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

fn is_write_vectored(&self) -> bool[src]

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

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

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

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

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

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

Attempts to write multiple buffers into this writer. Read more

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

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

fn by_ref(&mut self) -> &mut Self1.0.0[src]

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

impl<Inner: Write> WriteTerminal for TerminalWriter<Inner>[src]

fn color_support(&self) -> TerminalColorSupport[src]

Test whether this output stream supports color control codes.

fn color_preference(&self) -> bool[src]

Test whether the user has indicated a preference for color output by default. Respects the NO_COLOR environment variable where applicable. Read more

fn is_output_terminal(&self) -> bool[src]

Test whether the output is connected to a terminal. Read more

fn color_default(&self) -> bool[src]

Test whether color should be used on this terminal by default. This includes both whether color is supported and whether the user has not indicated a preference otherwise. Read more

impl<Inner: Write + OwnsRaw> OwnsRaw for TerminalWriter<Inner>[src]

impl<Inner: Write> Terminal for TerminalWriter<Inner>[src]

Auto Trait Implementations

impl<Inner> RefUnwindSafe for TerminalWriter<Inner> where
    Inner: RefUnwindSafe, 

impl<Inner> Send for TerminalWriter<Inner> where
    Inner: Send, 

impl<Inner> Sync for TerminalWriter<Inner> where
    Inner: Sync, 

impl<Inner> Unpin for TerminalWriter<Inner> where
    Inner: Unpin, 

impl<Inner> UnwindSafe for TerminalWriter<Inner> where
    Inner: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> AsUnsafeFile for T where
    T: AsRawFd + OwnsRaw, [src]

pub fn as_unsafe_file(&self) -> UnsafeFile[src]

Return the contained unsafe file.

fn as_file_view(&self) -> View<'_, File>[src]

Utility for returning a value which dereferences to a &File or &mut File. Read more

unsafe fn as_unscoped_file_view(&self) -> View<'static, File>[src]

Like as_file_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn eq_file<Filelike>(&self, other: &Filelike) -> bool where
    Filelike: AsUnsafeFile, [src]

Test whether self.as_unsafe_file().as_unsafe_handle() is equal to other.as_unsafe_file().as_unsafe_handle(). Read more

impl<T> AsUnsafeHandle for T where
    T: AsRawFd + OwnsRaw, [src]

pub fn as_unsafe_handle(&self) -> UnsafeHandle[src]

Return the contained unsafe handle.

fn eq_handle<Handlelike>(&self, other: &Handlelike) -> bool where
    Handlelike: AsUnsafeHandle, [src]

Test whether self.as_unsafe_handle() is equal to other.as_unsafe_handle(). Read more

impl<T> AsUnsafeSocket for T where
    T: AsRawFd + OwnsRaw, [src]

pub fn as_unsafe_socket(&self) -> UnsafeSocket[src]

Return the contained unsafe socket.

fn as_tcp_stream_view(&self) -> View<'_, TcpStream>[src]

Utility for returning a value which dereferences to a &TcpStream or &mut TcpStream. Read more

unsafe fn as_unscoped_tcp_stream_view(&self) -> View<'static, TcpStream>[src]

Like as_tcp_stream_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn as_tcp_listener_view(&self) -> View<'_, TcpListener>[src]

Utility for returning a value which dereferences to a &TcpListener or &mut TcpListener. Read more

unsafe fn as_unscoped_tcp_listener_view(&self) -> View<'static, TcpListener>[src]

Like as_tcp_listener_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn as_udp_socket_view(&self) -> View<'_, UdpSocket>[src]

Utility for returning a value which dereferences to a &UdpSocket or &mut UdpSocket. Read more

unsafe fn as_unscoped_udp_socket_view(&self) -> View<'static, UdpSocket>[src]

Like as_udp_socket_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn as_unix_stream_view(&self) -> View<'_, UnixStream>[src]

Utility for returning a value which dereferences to a &UnixStream or &mut UnixStream. Read more

unsafe fn as_unscoped_unix_stream_view(&self) -> View<'static, UnixStream>[src]

Like as_unix_stream_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn eq_socket<Socketlike>(&self, other: &Socketlike) -> bool where
    Socketlike: AsUnsafeSocket, [src]

Test whether self.as_unsafe_socket().as_unsafe_handle() is equal to other.as_unsafe_socket().as_unsafe_handle(). Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.