Struct Marks 

pub struct Marks { /* private fields */ }

The custom marks a document is read and written with.

Implementations

impl Marks

pub fn new() -> Self

pub fn with( self, name: impl Into<SharedString>, delimiter: impl Into<SharedString>, ) -> Self

Register name, spelled by delimiter on both sides — ==lit==.

An empty delimiter, or a second registration of a name or a delimiter already taken, is ignored: a registry that can hold two answers for one spelling has no reading of a document to offer.

pub fn is_empty(&self) -> bool

pub fn names(&self) -> impl Iterator<Item = &SharedString>

Every registered name, in the order they were added.

pub fn delimiter(&self, name: &str) -> Option<&str>

What spells name, for a caller writing its own markdown.

pub fn of(cx: &App) -> Self

What the editing surface reads a document with, or nothing registered.

Trait Implementations

impl Clone for Marks

fn clone(&self) -> Marks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Marks

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

Formats the value using the given formatter.

impl Default for Marks

fn default() -> Marks

Returns the “default value” for a type.

impl Eq for Marks

impl PartialEq for Marks

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Marks