Effect

Enum Effect 

Source
pub enum Effect {
Show 13 variants Bold, Faint, Italic, SolidUnderline, CurlyUnderline, DottedUnderline, DashedUnderline, Blink, Reverse, Conceal, Strikethrough, DoubleUnderline, Overline,
}
Expand description

An enumeration of all supported text styling effects.

Variants§

§

Bold

Bold styling.

§

Faint

Faint styling.

§

Italic

Italic styling.

§

SolidUnderline

Solid underline styling.

§

CurlyUnderline

Curly underline styling.

§

DottedUnderline

Dotted underline styling.

§

DashedUnderline

Dashed underline styling.

Blink styling.

§

Reverse

Reverse video styling.

§

Conceal

Conceal (hidden) styling.

§

Strikethrough

Strikethrough styling.

§

DoubleUnderline

Double underline styling.

§

Overline

Overline styling.

Implementations§

Source§

impl Effect

Source

pub const UNDERLINE: Effect = Effect::SolidUnderline

An alias for Effect::SolidUnderline.

Source§

impl Effect

Source

pub fn bold(self) -> Style

Sets the bold effect.

Source

pub fn faint(self) -> Style

Sets the faint effect.

Source

pub fn italic(self) -> Style

Sets the italic effect.

Source

pub fn underline(self) -> Style

Source

pub fn solid_underline(self) -> Style

Sets the solid underline effect.

Source

pub fn curly_underline(self) -> Style

Sets the curly underline effect.

Source

pub fn dotted_underline(self) -> Style

Sets the dotted underline effect.

Source

pub fn dashed_underline(self) -> Style

Sets the dashed underline effect.

Sets the blink effect.

Source

pub fn reverse(self) -> Style

Sets the reverse effect.

Source

pub fn conceal(self) -> Style

Sets the conceal effect.

Source

pub fn strikethrough(self) -> Style

Sets the strikethrough effect.

Source

pub fn double_underline(self) -> Style

Sets the double underline effect.

Source

pub fn overline(self) -> Style

Sets the overline effect.

Source

pub fn effect(self, effect: impl Into<Effect>) -> Style

Sets the given effect.

Source

pub fn underline_effect(self, underline_effect: UnderlineEffect) -> Style

Sets the underline effect.

Source

pub fn fg(self, color: impl Into<Color>) -> Style

Sets the foreground color.

Source

pub fn bg(self, color: impl Into<Color>) -> Style

Sets the background color.

Source

pub fn underline_color(self, color: impl Into<Color>) -> Style

Sets the underline color.

Source

pub fn color(self, targeted_color: impl Into<TargetedColor>) -> Style

Sets the given color in a target.

Source

pub fn add(self, element: impl StylingElement<Style>) -> Style

Adds the given element to the style.

Source

pub fn applied_to<C: Display>(self, content: C) -> Styled<C>

Applies the styling to the given content, returning a Styled<C> instance.

Source§

impl Effect

Source

pub fn to_style(self) -> Style

Converts the type into a Style.

Trait Implementations§

Source§

impl Clone for Effect

Source§

fn clone(&self) -> Effect

Returns a duplicate 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 Effect

Source§

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

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

impl Display for Effect

Source§

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

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

impl From<Effect> for Style

Source§

fn from(value: Effect) -> Self

Converts to this type from the input type.
Source§

impl From<UnderlineEffect> for Effect

Source§

fn from(value: UnderlineEffect) -> Self

Converts to this type from the input type.
Source§

impl Hash for Effect

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 PartialEq for Effect

Source§

fn eq(&self, other: &Effect) -> 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 Sequence for Effect

Source§

const CARDINALITY: usize = 13usize

Number of values of type Self. Read more
Source§

fn next(&self) -> Option<Self>

Returns value following *self or None if this was the end. Read more
Source§

fn previous(&self) -> Option<Self>

Returns value preceding *self or None if this was the beginning. Read more
Source§

fn first() -> Option<Self>

Returns the first value of type Self. Read more
Source§

fn last() -> Option<Self>

Returns the last value of type Self. Read more
Source§

impl StylingAttribute<Style> for Effect

Source§

type Value = bool

The type of value associated with this attribute.
Source§

fn set_in(self, composed_styling: Style, value: Self::Value) -> Style

Sets this attribute in the given parameter, returning it updated.
Source§

fn get_from(self, composed_styling: &Style) -> Self::Value

Gets the value of this attribute from the given parameter.
Source§

impl<C: Display> StylingAttribute<Styled<C>> for Effect

Source§

type Value = bool

The type of value associated with this attribute.
Source§

fn set_in(self, composed_styling: Styled<C>, value: Self::Value) -> Styled<C>

Sets this attribute in the given parameter, returning it updated.
Source§

fn get_from(self, composed_styling: &Styled<C>) -> Self::Value

Gets the value of this attribute from the given parameter.
Source§

impl StylingElement<Style> for Effect

Source§

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.
Source§

impl<C: Display> StylingElement<Styled<C>> for Effect

Source§

fn add_to(self, composed_styling: Styled<C>) -> Styled<C>

Adds this element to the given parameter, returning it updated.
Source§

impl Copy for Effect

Source§

impl Eq for Effect

Source§

impl StructuralPartialEq for Effect

Auto Trait Implementations§

§

impl Freeze for Effect

§

impl RefUnwindSafe for Effect

§

impl Send for Effect

§

impl Sync for Effect

§

impl Unpin for Effect

§

impl UnwindSafe for Effect

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, 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.