Struct writeable::Part

pub struct Part {
    pub category: &'static str,
    pub value: &'static str,
}

Parts are used as annotations for formatted strings.

For example, a string like Alice, Bob could assign a NAME part to the substrings Alice and Bob, and a PUNCTUATION part to , . This allows for example to apply styling only to names.

Part contains two fields, whose usage is left up to the producer of the Writeable. Conventionally, the category field will identify the formatting logic that produces the string/parts, whereas the value field will have semantic meaning. NAME and PUNCTUATION could thus be defined as

const NAME: Part = Part {
    category: "userlist",
    value: "name",
};
const PUNCTUATION: Part = Part {
    category: "userlist",
    value: "punctuation",
};

That said, consumers should not usually have to inspect Part internals. Instead, formatters should expose the Parts they produces as constants.

Fields

category: &'static str

value: &'static str

Implementations

impl Part

pub const ERROR: Part = _

A part that should annotate error segments in TryWriteable output.

For an example, see TryWriteable.

Trait Implementations

impl Clone for Part

fn clone(&self) -> Part

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Part

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

Formats the value using the given formatter.

impl PartialEq for Part

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

impl StructuralPartialEq for Part