Enum Span 

pub enum Span<'a> {
    Styled {
        text: &'a str,
        color: Color,
        styles: Styles,
    },
    StrikethroughWhitespace {
        text: &'a str,
        color: Color,
        styles: Styles,
    },
    Plain(&'a str),
}

Text with an associated color and associated styles.

Span implements Display and can be neatly printed.

Variants

Styled

A styled slice of text

Fields

text: &'a str

The styled text slice

color: Color

The color of the text

styles: Styles

Styles that should be applied to the text

StrikethroughWhitespace

An unbroken sequence of whitespace that was given the STRIKETHROUGH style.

The vanilla client renders whitespace with the STRIKETHROUGH style as a solid line; this variant allows for replicating that behavior.

Fields

text: &'a str

The styled whitespace slice

color: Color

The color of the whitespace (and therefore the line over it)

styles: Styles

Styles applied to the whitespace (will contain at least STRIKETHROUGH)

Plain(&'a str)

An unstyled slice of text

This should be given a default style. The vanilla client would use Color::White and Styles::empty().

Implementations

impl<'a> Span<'a>

pub fn new_plain(s: &'a str) -> Self

Create a new Span::Plain

pub fn new_strikethrough_whitespace( s: &'a str, color: Color, styles: Styles, ) -> Self

Create a new Span::StrikethroughWhitespace

pub fn new_styled(s: &'a str, color: Color, styles: Styles) -> Self

Create a new Span::Styled

pub fn wrap_colored(self) -> PrintSpanColored<'a>

Wraps this Span in a type that enables colored printing

Trait Implementations

impl<'a> Clone for Span<'a>

fn clone(&self) -> Span<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Span<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Span<'a>

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

Formats the value using the given formatter.

impl<'a> From<Span<'a>> for PrintSpanColored<'a>

fn from(s: Span<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Span<'a>

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<'a> PartialEq for Span<'a>

fn eq(&self, other: &Span<'a>) -> 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<'a> Copy for Span<'a>

impl<'a> Eq for Span<'a>

impl<'a> StructuralPartialEq for Span<'a>