Struct TextStyle

Source
pub struct TextStyle(/* private fields */);
Expand description

The style of text in a terminal emulator.

Note that not all styles may be supported on all platforms and by all terminal emulators. A misconfigured $TERM or terminfo database can also cause text styles to not render properly.

Implementations§

Source§

impl TextStyle

Source

pub const BOLD: Self

Source

pub const UNDERLINE: Self

Source

pub const DIMMED: Self

Source

pub const ITALIC: Self

Source

pub const STRIKETHROUGH: Self

Source

pub const REVERSED: Self

Source§

impl TextStyle

Source

pub const fn empty() -> Self

Returns an empty set of flags.

Source

pub const fn all() -> Self

Returns the set containing all flags.

Source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

Source

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

Source

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

Source

pub const fn from_bits_retain(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Source

pub fn from_name(name: &str) -> Option<Self>

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

Source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

Source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

Source

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

Source

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

Source

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

This method is equivalent to union.

Source

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

This method is equivalent to difference.

Source

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

Source

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

Source

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

Source

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

Source

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

Source

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

Source

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

Source§

impl TextStyle

Source

pub const fn iter(&self) -> Iter<TextStyle>

Iterate over enabled flag values.

Source

pub const fn iter_names(&self) -> IterNames<TextStyle>

Iterate over enabled flag values with their stringified names.

Source§

impl TextStyle

Source

pub fn reset(&mut self)

Reset this text style back to the default (no style).

Trait Implementations§

Source§

impl Binary for TextStyle

Source§

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

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

impl BitAnd for TextStyle

Source§

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

Source§

type Output = TextStyle

The resulting type after applying the & operator.
Source§

impl BitAndAssign for TextStyle

Source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

Source§

impl BitOr for TextStyle

Source§

fn bitor(self, other: TextStyle) -> Self

Returns the union of the two sets of flags.

Source§

type Output = TextStyle

The resulting type after applying the | operator.
Source§

impl BitOrAssign for TextStyle

Source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

Source§

impl BitXor for TextStyle

Source§

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

Source§

type Output = TextStyle

The resulting type after applying the ^ operator.
Source§

impl BitXorAssign for TextStyle

Source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

Source§

impl Clone for TextStyle

Source§

fn clone(&self) -> TextStyle

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextStyle

Source§

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

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

impl Default for TextStyle

Source§

fn default() -> TextStyle

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

impl Extend<TextStyle> for TextStyle

Source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl Flags for TextStyle

Source§

const FLAGS: &'static [Flag<TextStyle>]

The set of available flags and their names.
Source§

type Bits = u32

The underlying storage type.
Source§

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.
Source§

fn from_bits_retain(bits: u32) -> TextStyle

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Source§

fn empty() -> Self

Returns an empty set of flags.
Source§

fn all() -> Self

Returns the set containing all flags.
Source§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag. Read more
Source§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags. Read more
Source§

fn from_name(name: &str) -> Option<Self>

Get the flag for a particular name.
Source§

fn iter(&self) -> Iter<Self>

Iterate over enabled flag values.
Source§

fn iter_names(&self) -> IterNames<Self>

Iterate over the raw names and bits for enabled flag values.
Source§

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.
Source§

fn is_all(&self) -> bool

Returns true if all flags are currently set.
Source§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Returns true if there are flags common to both self and other.
Source§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Returns true if all of the flags in other are contained within self.
Source§

fn insert(&mut self, other: Self)
where Self: Sized,

Inserts the specified flags in-place. Read more
Source§

fn remove(&mut self, other: Self)
where Self: Sized,

Removes the specified flags in-place. Read more
Source§

fn toggle(&mut self, other: Self)
where Self: Sized,

Toggles the specified flags in-place. Read more
Source§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Inserts or removes the specified flags depending on the passed value.
Source§

fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.
Source§

fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.
Source§

fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.
Source§

fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.
Source§

fn complement(self) -> Self

Returns the complement of this set of flags.
Source§

impl FromIterator<TextStyle> for TextStyle

Source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator. Read more
Source§

impl Hash for TextStyle

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IntoIterator for TextStyle

Source§

type Item = TextStyle

The type of the elements being iterated over.
Source§

type IntoIter = Iter<TextStyle>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl LowerHex for TextStyle

Source§

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

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

impl Not for TextStyle

Source§

fn not(self) -> Self

Returns the complement of this set of flags.

Source§

type Output = TextStyle

The resulting type after applying the ! operator.
Source§

impl Octal for TextStyle

Source§

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

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

impl Ord for TextStyle

Source§

fn cmp(&self, other: &TextStyle) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for TextStyle

Source§

fn eq(&self, other: &TextStyle) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for TextStyle

Source§

fn partial_cmp(&self, other: &TextStyle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl PublicFlags for TextStyle

Source§

type Primitive = u32

The type of the underlying storage.
Source§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
Source§

impl Sub for TextStyle

Source§

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

Source§

type Output = TextStyle

The resulting type after applying the - operator.
Source§

impl SubAssign for TextStyle

Source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

Source§

impl UpperHex for TextStyle

Source§

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

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

impl Copy for TextStyle

Source§

impl Eq for TextStyle

Source§

impl StructuralPartialEq for TextStyle

Auto Trait Implementations§

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<B> BitFlags for B
where B: Flags,

Source§

type Iter = Iter<B>

👎Deprecated: use the Flags trait instead
An iterator over enabled flags in an instance of the type.
Source§

type IterNames = IterNames<B>

👎Deprecated: use the Flags trait instead
An iterator over the raw names and bits for enabled flags in an instance of the type.
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 = 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.