Struct Formatting

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

The default formatting used for rendering some text.

Implementations

impl Formatting

pub const BOLD: Self

Represents bold formatting.

pub const ITALIC: Self

Represents italic formatting.

pub const MONO: Self

Represents monospace formatting.

pub const TOP: Self

Represents superscript formatting.

pub const BOTTOM: Self

Represents subscript formatting.

pub const UNDERSCORE: Self

Represents underscore formatting.

pub const STRIKETHROUGH: Self

Represents strikethrough formatting.

pub fn contains(self, formatting: Self) -> bool

Checks if the Formatting instance contains any of the specified formatting flags.

Examples

Check if a Formatting instance contains specific formatting flags:

use pukram_formatting::Formatting;

let formatting = Formatting::BOLD | Formatting::ITALIC;
assert!(formatting.contains(Formatting::BOLD));
assert!(formatting.contains(Formatting::ITALIC));
assert!(!formatting.contains(Formatting::MONO));

pub fn is_empty(self) -> bool

Checks if the Formatting instance has no formatting flags set.

Examples

Check if a Formatting instance is empty:

use pukram_formatting::Formatting;

let formatting = Formatting::default();
assert!(formatting.is_empty());

let formatting = Formatting::BOLD | Formatting::ITALIC;
assert!(!formatting.is_empty());

pub fn is_bold(self) -> bool

Checks if bold formatting is activated.

pub fn is_italic(self) -> bool

Checks if italic formatting is activated.

pub fn is_mono(self) -> bool

Checks if monospace formatting is activated.

pub fn is_top(self) -> bool

Checks if superscript formatting is activated.

pub fn is_bottom(self) -> bool

Checks if subscript formatting is activated.

pub fn is_underscore(self) -> bool

Checks if underscore formatting is activated.

pub fn is_strikethrough(self) -> bool

Checks if strikethrough formatting is activated.

impl Formatting

pub fn apply(&mut self, c: char) -> bool

Apply character specific formatting and return if it has been changed.

Examples

Apply formatting characters to a Formatting instance:

use pukram_formatting::Formatting;

let mut formatting = Formatting::default();
assert!(formatting.is_empty());
assert!(formatting.apply('*'));
assert!(formatting.is_bold());
assert!(formatting.apply('/'));
assert!(formatting.is_italic());
assert!(!formatting.apply('A'));
assert!(formatting.apply('*'));
assert!(!formatting.is_bold());

Trait Implementations

impl BitAnd for Formatting

type Output = Formatting

The resulting type after applying the & operator.

fn bitand(self, rhs: Formatting) -> Formatting

Performs the & operation.

impl BitAndAssign for Formatting

fn bitand_assign(&mut self, rhs: Formatting)

Performs the &= operation.

impl BitOr for Formatting

type Output = Formatting

The resulting type after applying the | operator.

fn bitor(self, rhs: Formatting) -> Formatting

Performs the | operation.

impl BitOrAssign for Formatting

fn bitor_assign(&mut self, rhs: Formatting)

Performs the |= operation.

impl BitXor for Formatting

type Output = Formatting

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Formatting) -> Formatting

Performs the ^ operation.

impl BitXorAssign for Formatting

fn bitxor_assign(&mut self, rhs: Formatting)

Performs the ^= operation.

impl Clone for Formatting

fn clone(&self) -> Formatting

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Formatting

fn default() -> Formatting

Returns the “default value” for a type.

impl Copy for Formatting