Enum UnderlineStyle 

#[non_exhaustive]
pub enum UnderlineStyle {
    Straight,
    Double,
    Curly,
    Dotted,
    Dashed,
}

Underline rendering style, emitted as the CSI 4:Nm subparameter.

Straight is the plain SGR 4 default. The other variants require a terminal that supports the Kitty/VTE underline-style extension (Kitty, WezTerm, foot, recent VTE-based terminals); terminals without support fall back to a plain underline.

Example

use slt::{Color, Style, UnderlineStyle};

// A red curly "error" underline, like a spell-checker squiggle.
let err = Style::new()
    .underline_style(UnderlineStyle::Curly)
    .underline_color(Color::Red);
assert_eq!(err.underline_style, UnderlineStyle::Curly);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Straight

Plain straight underline (CSI 4:1m, the SGR 4 default).

Double

Double underline (CSI 4:2m).

Curly

Curly / “squiggly” underline (CSI 4:3m), commonly used for errors.

Dotted

Dotted underline (CSI 4:4m).

Dashed

Dashed underline (CSI 4:5m).

Trait Implementations

impl Clone for UnderlineStyle

fn clone(&self) -> UnderlineStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UnderlineStyle

impl Debug for UnderlineStyle

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

Formats the value using the given formatter.

impl Default for UnderlineStyle

fn default() -> UnderlineStyle

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnderlineStyle

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for UnderlineStyle

impl Hash for UnderlineStyle

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 UnderlineStyle

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UnderlineStyle