Enum CapabilityKind 

#[non_exhaustive]
pub enum CapabilityKind {
    Transform,
    Highlighter,
    FenceMarkup,
    FenceAnsi,
}

What a runtime plugin can contribute. The subset is chosen so that every contribution is text in and text out, which the host can check.

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.

Transform

Plain text in, plain text out: a named TextTransform. Styles on the input are not passed, and the output is unstyled.

Highlighter

Plain text in, style spans out: a regex-style Highlighter. Each output line is START END STYLE: byte offsets into the UTF-8 input, on character boundaries, with END exclusive, and STYLE a rich style such as bold red. A span the host cannot apply is skipped.

FenceMarkup

A Markdown fence’s code in, rich markup out ([bold]x[/]).

FenceAnsi

A Markdown fence’s code in, ANSI-styled text out. Only SGR (colour and attribute) sequences survive the host’s sanitizer.

Implementations

impl CapabilityKind

pub const ALL: [CapabilityKind; 4]

Every kind this host understands.

pub const fn code(self) -> u32

The number used in AbiCapability::kind.

pub fn from_code(code: u32) -> Option<Self>

The kind for a code, if this host knows it.

pub const fn as_str(self) -> &'static str

The name used in a manifest (fence-markup).

pub fn parse(name: &str) -> Option<Self>

The kind a manifest name spells, if this host knows it.

pub const fn produces_ansi(self) -> bool

Whether the output may keep ANSI styling (after sanitizing).

Trait Implementations

impl Clone for CapabilityKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CapabilityKind

impl Debug for CapabilityKind

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

Formats the value using the given formatter.

impl Display for CapabilityKind

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

Formats the value using the given formatter.

impl Eq for CapabilityKind

impl Hash for CapabilityKind

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

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 CapabilityKind

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for CapabilityKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CapabilityKind

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for CapabilityKind