Skip to main content

AnsiWriter

Struct AnsiWriter 

Source
pub struct AnsiWriter<W> { /* private fields */ }
Expand description

A backend that writes Urushi commands as ANSI, CSI, OSC, and C0 bytes.

This type owns only the output half of a terminal connection. Input parsing, process-side raw mode, and platform queries are deliberately separate: an interactive backend composes them around the same physical endpoint.

Implementations§

Source§

impl<W> AnsiWriter<W>

Source

pub const fn new(writer: W) -> Self

Source

pub const fn writer(&self) -> &W

Source

pub fn writer_mut(&mut self) -> &mut W

Source

pub fn into_inner(self) -> W

Source§

impl<W: Write> AnsiWriter<W>

Source

pub fn write_style_prefix(&mut self, style: TerminalStyle) -> Result<()>

Writes the SGR sequence that enables style, if it has any active part.

Unlike Command::SetStyle, this does not reset prior terminal state. It is intended for a caller that owns a self-contained style scope and closes it with Self::write_style_reset.

Source

pub fn write_style_reset(&mut self) -> Result<()>

Writes the SGR sequence that restores the default style.

Writes an OSC 8 sequence that starts link.

Writes the OSC 8 sequence that closes the active hyperlink.

Trait Implementations§

Source§

impl<W: Write> CommandWriter for AnsiWriter<W>

Source§

fn write_command(&mut self, command: Command<'_>) -> Result<()>

Queues or writes one command.
Source§

impl<W: Write> TerminalOutput for AnsiWriter<W>

Source§

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

Auto Trait Implementations§

§

impl<W> Freeze for AnsiWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for AnsiWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for AnsiWriter<W>
where W: Send,

§

impl<W> Sync for AnsiWriter<W>
where W: Sync,

§

impl<W> Unpin for AnsiWriter<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for AnsiWriter<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for AnsiWriter<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.