Skip to main content

Role

Enum Role 

Source
pub enum Role {
    Body,
    Heading(u8),
    Code,
    Link,
    Mark,
    ListMarker,
    QuoteGutter,
    Rule,
    Delimiter,
    Image,
}
Expand description

What a glyph is, typographically — the semantic role a frontend maps to its own presentation. Mutually exclusive per glyph (a glyph is a heading, or a link, or body text — not two at once); the compositional emphasis a run can also carry lives in Style’s bold/italic/underline/strikethrough flags alongside this.

Variants§

§

Body

Ordinary prose — the surface’s default text.

§

Heading(u8)

A heading of the given level (1 = top). A GUI scales the font by level; a terminal cycles a color by it.

§

Code

Code — inline `verbatim` or a fenced block. A GUI renders it in a monospace family; a terminal tints it.

A hyperlink’s visible text (or bare URL/email).

§

Mark

Highlighted / marked text (==mark==).

§

ListMarker

A list item’s bullet or number — synthetic decoration, not authored text.

§

QuoteGutter

A block quote’s gutter (), drawn down its left edge.

§

Rule

A drawn rule: a thematic break (───) or a table’s borders. A GUI that draws its own tables ignores the border glyphs; the rule still reaches it.

§

Delimiter

Raw markup a revealed line is showing: the * around an emphasis, the # opening a heading, a link’s ](dest). Only ever emitted for the caret’s line under MarkupMode::Full — every other line resolves its markup away and has none of these.

A role rather than a Style flag because it is what the glyph is: the delimiter of an emphasis is not itself emphasised text. A frontend typically dims it, so the revealed line still reads as prose with its scaffolding visible rather than as source code. One that doesn’t map it draws it as body text, which is correct if unsubtle.

§

Image

A block-level image’s placeholder text (🖼 alt). The glyphs are a default rendering any surface can paint as-is (a terminal shows the label); an image-capable frontend skips the placeholder row named by the map’s ImageInfo rows_span and paints the real picture in its place — the same skip-the-picture contract Role::Rule table borders use.

Trait Implementations§

Source§

impl Clone for Role

Source§

fn clone(&self) -> Role

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Role

Source§

impl Debug for Role

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Role

Source§

fn default() -> Role

Returns the “default value” for a type. Read more
Source§

impl Eq for Role

Source§

impl PartialEq for Role

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Role

Auto Trait Implementations§

§

impl Freeze for Role

§

impl RefUnwindSafe for Role

§

impl Send for Role

§

impl Sync for Role

§

impl Unpin for Role

§

impl UnsafeUnpin for Role

§

impl UnwindSafe for Role

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.