Struct Form

pub struct Form {
    pub style: ContentStyle,
}

A style for text.

Fields

style: ContentStyle

The actual style that is applied

Implementations

impl Form

pub const fn bold() -> BuiltForm

New Form with the bold attribute

pub const fn dim() -> BuiltForm

New Form with the dim attribute

pub const fn italic() -> BuiltForm

New Form with the italic attribute

pub const fn underlined() -> BuiltForm

New Form with the underlined attribute

pub const fn double_underlined() -> BuiltForm

New Form with the double_underlined attribute

pub const fn undercurled() -> BuiltForm

New Form with the undercurled attribute

pub const fn underdashed() -> BuiltForm

New Form with the underdashed attribute

pub const fn reverse() -> BuiltForm

New Form with the reverse attribute

pub const fn crossed_out() -> BuiltForm

New Form with the crossed_out attribute

pub const fn black() -> BuiltForm

New Form with a black foreground

pub const fn on_black() -> BuiltForm

New Form with a black background

pub const fn underline_black() -> BuiltForm

New Form with a black underlining

Do note that this feature may not be supported in all Uis.

pub const fn dark_grey() -> BuiltForm

New Form with a dark_grey foreground

pub const fn on_dark_grey() -> BuiltForm

New Form with a dark_grey background

pub const fn underline_dark_grey() -> BuiltForm

New Form with a dark_grey underlining

Do note that this feature may not be supported in all Uis.

pub const fn red() -> BuiltForm

New Form with a red foreground

pub const fn on_red() -> BuiltForm

New Form with a red background

pub const fn underline_red() -> BuiltForm

New Form with a red underlining

Do note that this feature may not be supported in all Uis.

pub const fn dark_red() -> BuiltForm

New Form with a dark_red foreground

pub const fn on_dark_red() -> BuiltForm

New Form with a dark_red background

pub const fn underline_dark_red() -> BuiltForm

New Form with a dark_red underlining

Do note that this feature may not be supported in all Uis.

pub const fn green() -> BuiltForm

New Form with a green foreground

pub const fn on_green() -> BuiltForm

New Form with a green background

pub const fn underline_green() -> BuiltForm

New Form with a green underlining

Do note that this feature may not be supported in all Uis.

pub const fn dark_green() -> BuiltForm

New Form with a dark_green foreground

pub const fn on_dark_green() -> BuiltForm

New Form with a dark_green background

pub const fn underline_dark_green() -> BuiltForm

New Form with a dark_green underlining

Do note that this feature may not be supported in all Uis.

pub const fn yellow() -> BuiltForm

New Form with a yellow foreground

pub const fn on_yellow() -> BuiltForm

New Form with a yellow background

pub const fn underline_yellow() -> BuiltForm

New Form with a yellow underlining

Do note that this feature may not be supported in all Uis.

pub const fn dark_yellow() -> BuiltForm

New Form with a dark_yellow foreground

pub const fn on_dark_yellow() -> BuiltForm

New Form with a dark_yellow background

pub const fn underline_dark_yellow() -> BuiltForm

New Form with a dark_yellow underlining

Do note that this feature may not be supported in all Uis.

pub const fn blue() -> BuiltForm

New Form with a blue foreground

pub const fn on_blue() -> BuiltForm

New Form with a blue background

pub const fn underline_blue() -> BuiltForm

New Form with a blue underlining

Do note that this feature may not be supported in all Uis.

pub const fn dark_blue() -> BuiltForm

New Form with a dark_blue foreground

pub const fn on_dark_blue() -> BuiltForm

New Form with a dark_blue background

pub const fn underline_dark_blue() -> BuiltForm

New Form with a dark_blue underlining

Do note that this feature may not be supported in all Uis.

pub const fn magenta() -> BuiltForm

New Form with a magenta foreground

pub const fn on_magenta() -> BuiltForm

New Form with a magenta background

pub const fn underline_magenta() -> BuiltForm

New Form with a magenta underlining

Do note that this feature may not be supported in all Uis.

pub const fn dark_magenta() -> BuiltForm

New Form with a dark_magenta foreground

pub const fn on_dark_magenta() -> BuiltForm

New Form with a dark_magenta background

pub const fn underline_dark_magenta() -> BuiltForm

New Form with a dark_magenta underlining

Do note that this feature may not be supported in all Uis.

pub const fn cyan() -> BuiltForm

New Form with a cyan foreground

pub const fn on_cyan() -> BuiltForm

New Form with a cyan background

pub const fn underline_cyan() -> BuiltForm

New Form with a cyan underlining

Do note that this feature may not be supported in all Uis.

pub const fn dark_cyan() -> BuiltForm

New Form with a dark_cyan foreground

pub const fn on_dark_cyan() -> BuiltForm

New Form with a dark_cyan background

pub const fn underline_dark_cyan() -> BuiltForm

New Form with a dark_cyan underlining

Do note that this feature may not be supported in all Uis.

pub const fn white() -> BuiltForm

New Form with a white foreground

pub const fn on_white() -> BuiltForm

New Form with a white background

pub const fn underline_white() -> BuiltForm

New Form with a white underlining

Do note that this feature may not be supported in all Uis.

pub const fn grey() -> BuiltForm

New Form with a grey foreground

pub const fn on_grey() -> BuiltForm

New Form with a grey background

pub const fn underline_grey() -> BuiltForm

New Form with a grey underlining

Do note that this feature may not be supported in all Uis.

impl Form

pub const fn new() -> BuiltForm

Returns a new Form with a default style

This method actually returns BuiltForm

pub const fn reset() -> BuiltForm

Returns a new Form with the Reset attribute

In Duat, the Reset attribute should remove only other Attributes, not any of the colors in use.

pub const fn with(str: &str) -> BuiltForm

New Form with a colored foreground

This function accepts three color formats:

• A hexcode, like "#abcdef", capitalization is ignored;
• Three rgb values, like "rgb 123 456 789";
• Three hsl values, like "hsl {hue} {sat} {lit}", where {hue}, {sat} and {lit} can either be a number from 0..255, or a percentage, followed by '%', e.g. "hsl 234 50% 42".

pub const fn on(str: &str) -> BuiltForm

New Form with a colored background

This function accepts three color formats:

• A hexcode, like "#abcdef", capitalization is ignored;
• Three rgb values, like "rgb 123 456 789";
• Three hsl values, like "hsl {hue} {sat} {lit}", where {hue}, {sat} and {lit} can either be a number from 0..255, or a percentage, followed by '%', e.g. "hsl 234 50% 42".

pub const fn underline(str: &str) -> BuiltForm

New Form with a colored underlining

This function accepts three color formats:

• A hexcode, like "#abcdef", capitalization is ignored;
• Three rgb values, like "rgb 123 456 789";
• Three hsl values, like "hsl {hue} {sat} {lit}", where {hue}, {sat} and {lit} can either be a number from 0..255, or a percentage, followed by '%', e.g. "hsl 234 50% 42".

pub const fn fg(&self) -> Option<Color>

The foreground color

pub const fn bg(&self) -> Option<Color>

The background color

pub const fn ul(&self) -> Option<Color>

The foreground color

pub const fn attrs(&self) -> Attributes

The attributes

Trait Implementations

impl Clone for Form

fn clone(&self) -> Form

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Form

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

Formats the value using the given formatter.

impl From<BuiltForm> for Form

fn from(value: BuiltForm) -> Self

Converts to this type from the input type.

impl PartialEq for Form

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

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

const 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 Copy for Form

impl Eq for Form

impl FormFmt for Form

impl StructuralPartialEq for Form