Struct Styles

pub struct Styles { /* private fields */ }

Styles that can be combined and applied to a Span.

The RESET flag is missing because the parser implemented in SpanIter takes care of it for you.

See wiki.vg’s docs for detailed info about each style.

Examples

use mc_legacy_formatting::Styles;
let styles = Styles::BOLD | Styles::ITALIC | Styles::UNDERLINED;

assert!(styles.contains(Styles::BOLD));
assert!(!styles.contains(Styles::RANDOM));

Implementations

impl Styles

pub const RANDOM: Styles

Signals that the Span’s text should be replaced with randomized characters at a constant interval

pub const BOLD: Styles

Signals that the Span’s text should be bold

pub const STRIKETHROUGH: Styles

Signals that the Span’s text should be strikethrough

pub const UNDERLINED: Styles

Signals that the Span’s text should be underlined

pub const ITALIC: Styles

Signals that the Span’s text should be italic

pub const fn empty() -> Styles

Returns an empty set of flags

pub const fn all() -> Styles

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Styles>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Styles

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Styles

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Styles) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Styles) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Styles)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Styles)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Styles)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Styles, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl Styles

pub fn from_char(c: char) -> Option<Self>

Map a char to a Styles object.

Returns None if c didn’t map to a Styles object.

Trait Implementations

impl Binary for Styles

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

Formats the value using the given formatter.

impl BitAnd for Styles

fn bitand(self, other: Styles) -> Styles

Returns the intersection between the two sets of flags.

type Output = Styles

The resulting type after applying the & operator.

impl BitAndAssign for Styles

fn bitand_assign(&mut self, other: Styles)

Disables all flags disabled in the set.

impl BitOr for Styles

fn bitor(self, other: Styles) -> Styles

Returns the union of the two sets of flags.

type Output = Styles

The resulting type after applying the | operator.

impl BitOrAssign for Styles

fn bitor_assign(&mut self, other: Styles)

Adds the set of flags.

impl BitXor for Styles

fn bitxor(self, other: Styles) -> Styles

Returns the left flags, but with all the right flags toggled.

type Output = Styles

The resulting type after applying the ^ operator.

impl BitXorAssign for Styles

fn bitxor_assign(&mut self, other: Styles)

Toggles the set of flags.

impl Clone for Styles

fn clone(&self) -> Styles

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Styles

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

Formats the value using the given formatter.

impl Default for Styles

fn default() -> Styles

Returns the “default value” for a type.

impl Extend<Styles> for Styles

fn extend<T: IntoIterator<Item = Styles>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Styles> for Styles

fn from_iter<T: IntoIterator<Item = Styles>>(iterator: T) -> Styles

Creates a value from an iterator.

impl Hash for Styles

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 LowerHex for Styles

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

Formats the value using the given formatter.

impl Not for Styles

fn not(self) -> Styles

Returns the complement of this set of flags.

type Output = Styles

The resulting type after applying the ! operator.

impl Octal for Styles

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

Formats the value using the given formatter.

impl Ord for Styles

fn cmp(&self, other: &Styles) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Styles

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

fn partial_cmp(&self, other: &Styles) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Styles

fn sub(self, other: Styles) -> Styles

Returns the set difference of the two sets of flags.

type Output = Styles

The resulting type after applying the - operator.

impl SubAssign for Styles

fn sub_assign(&mut self, other: Styles)

Disables all flags enabled in the set.

impl UpperHex for Styles

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

Formats the value using the given formatter.

impl Copy for Styles

impl Eq for Styles

impl StructuralPartialEq for Styles