Struct BuiltForm 

pub struct BuiltForm(/* private fields */);

A convenience struct for Forms

This struct exists in order to have Form methods be initializers, while BuiltForm methods consume and return a BuiltForms

This is their only difference, everywhere else, they are functionally identical.

Implementations

impl BuiltForm

pub const fn bold(self) -> Self

Applies the bold attribute to this Form

pub const fn dim(self) -> Self

Applies the dim attribute to this Form

pub const fn italic(self) -> Self

Applies the italic attribute to this Form

pub const fn underlined(self) -> Self

Applies the underlined attribute to this Form

pub const fn double_underlined(self) -> Self

Applies the double_underlined attribute to this Form

pub const fn undercurled(self) -> Self

Applies the undercurled attribute to this Form

pub const fn underdashed(self) -> Self

Applies the underdashed attribute to this Form

pub const fn reverse(self) -> Self

Applies the reverse attribute to this Form

pub const fn crossed_out(self) -> Self

Applies the crossed_out attribute to this Form

pub const fn overlined(self) -> Self

Applies the overlined attribute to this Form

pub const fn black(self) -> Self

Turns the foreground of this Form black

pub const fn on_black(self) -> Self

Turns the background of this Form black

pub const fn underline_black(self) -> Self

Turns the underlining of this Form black

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

pub const fn dark_grey(self) -> Self

Turns the foreground of this Form dark_grey

pub const fn on_dark_grey(self) -> Self

Turns the background of this Form dark_grey

pub const fn underline_dark_grey(self) -> Self

Turns the underlining of this Form dark_grey

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

pub const fn red(self) -> Self

Turns the foreground of this Form red

pub const fn on_red(self) -> Self

Turns the background of this Form red

pub const fn underline_red(self) -> Self

Turns the underlining of this Form red

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

pub const fn dark_red(self) -> Self

Turns the foreground of this Form dark_red

pub const fn on_dark_red(self) -> Self

Turns the background of this Form dark_red

pub const fn underline_dark_red(self) -> Self

Turns the underlining of this Form dark_red

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

pub const fn green(self) -> Self

Turns the foreground of this Form green

pub const fn on_green(self) -> Self

Turns the background of this Form green

pub const fn underline_green(self) -> Self

Turns the underlining of this Form green

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

pub const fn dark_green(self) -> Self

Turns the foreground of this Form dark_green

pub const fn on_dark_green(self) -> Self

Turns the background of this Form dark_green

pub const fn underline_dark_green(self) -> Self

Turns the underlining of this Form dark_green

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

pub const fn yellow(self) -> Self

Turns the foreground of this Form yellow

pub const fn on_yellow(self) -> Self

Turns the background of this Form yellow

pub const fn underline_yellow(self) -> Self

Turns the underlining of this Form yellow

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

pub const fn dark_yellow(self) -> Self

Turns the foreground of this Form dark_yellow

pub const fn on_dark_yellow(self) -> Self

Turns the background of this Form dark_yellow

pub const fn underline_dark_yellow(self) -> Self

Turns the underlining of this Form dark_yellow

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

pub const fn blue(self) -> Self

Turns the foreground of this Form blue

pub const fn on_blue(self) -> Self

Turns the background of this Form blue

pub const fn underline_blue(self) -> Self

Turns the underlining of this Form blue

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

pub const fn dark_blue(self) -> Self

Turns the foreground of this Form dark_blue

pub const fn on_dark_blue(self) -> Self

Turns the background of this Form dark_blue

pub const fn underline_dark_blue(self) -> Self

Turns the underlining of this Form dark_blue

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

pub const fn magenta(self) -> Self

Turns the foreground of this Form magenta

pub const fn on_magenta(self) -> Self

Turns the background of this Form magenta

pub const fn underline_magenta(self) -> Self

Turns the underlining of this Form magenta

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

pub const fn dark_magenta(self) -> Self

Turns the foreground of this Form dark_magenta

pub const fn on_dark_magenta(self) -> Self

Turns the background of this Form dark_magenta

pub const fn underline_dark_magenta(self) -> Self

Turns the underlining of this Form dark_magenta

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

pub const fn cyan(self) -> Self

Turns the foreground of this Form cyan

pub const fn on_cyan(self) -> Self

Turns the background of this Form cyan

pub const fn underline_cyan(self) -> Self

Turns the underlining of this Form cyan

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

pub const fn dark_cyan(self) -> Self

Turns the foreground of this Form dark_cyan

pub const fn on_dark_cyan(self) -> Self

Turns the background of this Form dark_cyan

pub const fn underline_dark_cyan(self) -> Self

Turns the underlining of this Form dark_cyan

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

pub const fn white(self) -> Self

Turns the foreground of this Form white

pub const fn on_white(self) -> Self

Turns the background of this Form white

pub const fn underline_white(self) -> Self

Turns the underlining of this Form white

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

pub const fn grey(self) -> Self

Turns the foreground of this Form grey

pub const fn on_grey(self) -> Self

Turns the background of this Form grey

pub const fn underline_grey(self) -> Self

Turns the underlining of this Form grey

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

impl BuiltForm

pub const fn reset(self) -> BuiltForm

Adds the Reset attribute to this Form

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

pub const fn with(self, str: &str) -> Self

Colors the foreground of this Form

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(self, str: &str) -> Self

Colors the background of this Form

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(self, str: &str) -> Self

Colors the underlining of this Form

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

Methods from Deref<Target = Form>

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

The foreground color

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

The background color

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

The foreground color

pub fn attrs(&self) -> Attributes

The attributes

Trait Implementations

impl Clone for BuiltForm

fn clone(&self) -> BuiltForm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltForm

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

Formats the value using the given formatter.

impl Deref for BuiltForm

type Target = Form

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for BuiltForm

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<BuiltForm> for Form

fn from(value: BuiltForm) -> Self

Converts to this type from the input type.

impl Copy for BuiltForm

impl FormFmt for BuiltForm