Enum fiberplane_models::formatting::Annotation

#[non_exhaustive]
pub enum Annotation {
    StartBold,
    EndBold,
    StartCode,
    EndCode,
    StartHighlight,
    EndHighlight,
    StartItalics,
    EndItalics,
    Label(Label),
    StartLink {
        url: String,
    },
    EndLink,
    Mention(Mention),
    StartStrikethrough,
    EndStrikethrough,
    Timestamp {
        timestamp: Timestamp,
    },
    StartUnderline,
    EndUnderline,
}

A rich-text annotation.

Annotations are typically found inside a Formatting vector.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

StartBold

EndBold

StartCode

EndCode

StartHighlight

EndHighlight

StartItalics

EndItalics

Label(Label)

StartLink

Fields

url: String

EndLink

Mention(Mention)

StartStrikethrough

EndStrikethrough

Timestamp

Fields

timestamp: Timestamp

StartUnderline

EndUnderline

Implementations

impl Annotation

pub fn is_paired_annotation(&self) -> bool

Returns whether the annotation is one of a Start*/End* pair.

pub fn toggle_opposite(&self) -> Option<Annotation>

Returns the opposite of an annotation for the purpose of toggling the formatting.

Returns None if the annotation is not part of a pair, or if the formatting cannot be toggled without more information.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Annotation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Annotation

fn eq(&self, other: &Annotation) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Annotation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Annotation

impl StructuralPartialEq for Annotation