Enum UnderlineEffect 

pub enum UnderlineEffect {
    Solid,
    Curly,
    Dotted,
    Dashed,
    Double,
}

An enumeration of all supported underline effects.

The values correspond to a subset of Effect.

Variants

Solid

Solid underline styling.

Curly

Curly underline styling.

Dotted

Dotted underline styling.

Dashed

Dashed underline styling.

Double

Double underline styling.

Implementations

impl UnderlineEffect

pub fn bold(self) -> Style

Sets the bold effect.

pub fn faint(self) -> Style

Sets the faint effect.

pub fn italic(self) -> Style

Sets the italic effect.

pub fn underline(self) -> Style

An alias for Self::solid_underline().

pub fn solid_underline(self) -> Style

Sets the solid underline effect.

pub fn curly_underline(self) -> Style

Sets the curly underline effect.

pub fn dotted_underline(self) -> Style

Sets the dotted underline effect.

pub fn dashed_underline(self) -> Style

Sets the dashed underline effect.

pub fn blink(self) -> Style

Sets the blink effect.

pub fn reverse(self) -> Style

Sets the reverse effect.

pub fn conceal(self) -> Style

Sets the conceal effect.

pub fn strikethrough(self) -> Style

Sets the strikethrough effect.

pub fn double_underline(self) -> Style

Sets the double underline effect.

pub fn overline(self) -> Style

Sets the overline effect.

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

Sets the given effect.

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

Sets the underline effect.

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

Sets the foreground color.

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

Sets the background color.

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

Sets the underline color.

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

Sets the given color in a target.

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

Adds the given element to the style.

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

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

impl UnderlineEffect

pub fn to_style(self) -> Style

Converts the type into a Style.

impl UnderlineEffect

pub fn to_effect(self) -> Effect

Converts the type into an Effect.

Trait Implementations

impl Clone for UnderlineEffect

fn clone(&self) -> UnderlineEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnderlineEffect

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

Formats the value using the given formatter.

impl Default for UnderlineEffect

fn default() -> UnderlineEffect

Returns the “default value” for a type.

impl Display for UnderlineEffect

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

Formats the value using the given formatter.

impl From<UnderlineEffect> for Effect

fn from(value: UnderlineEffect) -> Self

Converts to this type from the input type.

impl From<UnderlineEffect> for Style

fn from(value: UnderlineEffect) -> Self

Converts to this type from the input type.

impl Hash for UnderlineEffect

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for UnderlineEffect

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Sequence for UnderlineEffect

const CARDINALITY: usize = 5usize

Number of values of type Self.

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

Returns value following *self or None if this was the end.

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

Returns value preceding *self or None if this was the beginning.

fn first() -> Option<Self>

Returns the first value of type Self.

fn last() -> Option<Self>

Returns the last value of type Self.

impl StylingAttribute<Style> for UnderlineEffect

type Value = bool

The type of value associated with this attribute.

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

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

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

Gets the value of this attribute from the given parameter.

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

type Value = bool

The type of value associated with this attribute.

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

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

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

Gets the value of this attribute from the given parameter.

impl StylingElement<Style> for UnderlineEffect

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

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

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

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

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

impl Copy for UnderlineEffect

impl Eq for UnderlineEffect

impl StructuralPartialEq for UnderlineEffect