Enum Part

pub enum Part {
    Char(char),
    PushForm(FormId),
    PopForm(FormId),
    MainCaret,
    ExtraCaret,
    AlignLeft,
    AlignCenter,
    AlignRight,
    Spacer,
    ToggleStart(ToggleId),
    ToggleEnd(ToggleId),
    ResetState,
}

A part of the Text, can be a char or a Tag.

This type is used in iteration by Uis in order to correctly print Duat’s content. Additionally, you may be able to tell that there is no ghost text or concealment tags, and there is a ResetState.

That is because the Text’s iteration process automatically gets rid of these tags, since, from the point of view of the ui, ghost text is just regular text, while conceals are simply the lack of text. And if the ui can handle printing regular text, printing ghost text should be a breeze.

Variants

Char(char)

A printed char, can be real or a Ghost

PushForm(FormId)

Push a Form to the Painter

PopForm(FormId)

Pop a Form from the Painter

MainCaret

Place the main caret or the "MainCaret" Form to the Painter

ExtraCaret

Place the extra caret or the "ExtraCaret" Form to the Painter

AlignLeft

End other forms of alignment

AlignCenter

Begin centered alignment

AlignRight

Begin right alignment

Spacer

Add a Spacer

ToggleStart(ToggleId)

Starts a toggleable region for the given ToggleId

Not yet implemented

ToggleEnd(ToggleId)

Ends a toggleable region for the given ToggleId

Not yet implemented

ResetState

Resets all FormIds, ToggleIds and alignments

Used when a Conceal covers a large region, which Duat optimizes by just not iterating over the Parts within. This could skip some Tags, so this variant serves the purpose of terminating or initiating in place of skipped Tags

Implementations

impl Part

pub fn is_char(&self) -> bool

Returns true if the part is Char

pub fn as_char(&self) -> Option<char>

Returns Some if the part is Char

pub fn is_tag(&self) -> bool

Returns true if the part is not Char

Trait Implementations

impl Clone for Part

fn clone(&self) -> Part

Returns a duplicate of the value.

const 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 ==.

const 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 Eq for Part

impl StructuralPartialEq for Part