Struct DocText 

pub struct DocText { /* private fields */ }

Lazily resolved documentation text.

Implementations

impl DocText

pub fn plain(raw: EcoString) -> DocText

Creates documentation that is already ready to display as Markdown.

pub fn official(raw: EcoString) -> DocText

Creates official Typst documentation that must be converted before display.

pub fn raw(&self) -> &EcoString

Gets the raw documentation text.

pub fn kind(&self) -> DocTextKind

Gets the source format of this documentation text.

pub fn get_or_init( &self, convert_official: impl FnOnce(&EcoString) -> EcoString, ) -> &EcoString

Gets display-ready documentation text.

Trait Implementations

impl Clone for DocText

fn clone(&self) -> DocText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocText

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

Formats the value using the given formatter.

impl Hash for DocText

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DocText

fn cmp(&self, other: &DocText) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DocText

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

fn partial_cmp(&self, other: &DocText) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for DocText