Skip to main content

MystDirective

Struct MystDirective 

Source
pub struct MystDirective(/* private fields */);
Expand description

A MyST directive (```{name} or, with colon_fence, :::{name}).

Implementations§

Source§

impl MystDirective

Source

pub fn name(&self) -> Option<String>

Returns the bare directive name (braces stripped): {note} -> note.

Source

pub fn argument(&self) -> Option<String>

Returns the trimmed argument following the name on the opener line, if any (e.g. ```{code-block} python -> python).

Source

pub fn options(&self) -> Vec<MystDirectiveOption>

Returns the directive’s leading :key: value option lines.

Source

pub fn body(&self) -> Option<String>

Returns the verbatim body of a verbatim directive (code, math, …).

Prose directives whose body is recursively parsed as ordinary blocks have no MYST_DIRECTIVE_BODY node and yield None.

Trait Implementations§

Source§

impl AstNode for MystDirective

Source§

type Language = PanacheLanguage

Source§

fn can_cast(kind: SyntaxKind) -> bool

Source§

fn cast(syntax: SyntaxNode) -> Option<Self>

Source§

fn syntax(&self) -> &SyntaxNode

Source§

fn clone_for_update(&self) -> Self
where Self: Sized,

Source§

fn clone_subtree(&self) -> Self
where Self: Sized,

Auto Trait Implementations§

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> 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, 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.