Skip to main content

Pen

Struct Pen 

Source
pub struct Pen {
    pub fg: Color,
    pub bg: Color,
    pub flags: CellFlags,
    pub underline_color: Color,
}
Expand description

The current SGR state — the appearance copied into each printed cell.

Modelling it as a “template cell” mirrors Alacritty: a later slice can make erase (ED/EL) fill cleared cells with bg instead of Default and that is Background Color Erase (BCE), no structural change. See term.rs.

Fields§

§fg: Color§bg: Color§flags: CellFlags§underline_color: Color

The underline colour (SGR 58, #520): what an underline / strikethrough draws in, independent of fg. Default means “follow the fg”. It is not packed into the printed Cell (the 12-byte cell is full); the print path stamps a non-default value into the row’s ucolor map. See term.rs::write_glyph.

Implementations§

Source§

impl Pen

Source

pub fn reset(&mut self)

Reset to default appearance (SGR 0).

Source

pub fn cell(&self, c: char) -> Cell

Build a cell carrying this pen’s appearance and the given glyph.

Trait Implementations§

Source§

impl Clone for Pen

Source§

fn clone(&self) -> Pen

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Pen

Source§

impl Debug for Pen

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Pen

Source§

fn default() -> Pen

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Pen

§

impl RefUnwindSafe for Pen

§

impl Send for Pen

§

impl Sync for Pen

§

impl Unpin for Pen

§

impl UnsafeUnpin for Pen

§

impl UnwindSafe for Pen

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.