Skip to main content

DocNode

dioxus_mdx::parser

Enum DocNode

pub enum DocNode {
Show 16 variants
    Markdown(String),
    Callout(CalloutNode),
    Card(CardNode),
    CardGroup(CardGroupNode),
    Tabs(TabsNode),
    Steps(StepsNode),
    AccordionGroup(AccordionGroupNode),
    CodeBlock(CodeBlockNode),
    CodeGroup(CodeGroupNode),
    ParamField(ParamFieldNode),
    ResponseField(ResponseFieldNode),
    Expandable(ExpandableNode),
    RequestExample(RequestExampleNode),
    ResponseExample(ResponseExampleNode),
    Update(UpdateNode),
    OpenApi(OpenApiNode),
}

Expand description

A node in the parsed documentation tree.

Variants§

Markdown(String)

Plain markdown content to be rendered as HTML.

Callout(CalloutNode)

Callout box (Tip, Note, Warning, Info).

Card(CardNode)

Card with title, icon, optional link, and content.

CardGroup(CardGroupNode)

Group of cards in a grid layout.

Tabs(TabsNode)

Tabbed content container.

Steps(StepsNode)

Sequential steps guide.

AccordionGroup(AccordionGroupNode)

Collapsible accordion group.

CodeBlock(CodeBlockNode)

Code block with optional language.

CodeGroup(CodeGroupNode)

Code group with multiple language variants.

ParamField(ParamFieldNode)

API parameter field.

ResponseField(ResponseFieldNode)

API response field.

Expandable(ExpandableNode)

Expandable section.

RequestExample(RequestExampleNode)

Request example container.

ResponseExample(ResponseExampleNode)

Response example container.

Update(UpdateNode)

Changelog update entry.

OpenApi(OpenApiNode)

OpenAPI specification viewer.

Trait Implementations§

impl Clone for DocNode

fn clone(&self) -> DocNode

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for DocNode

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

Formats the value using the given formatter. Read more

impl PartialEq for DocNode

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 StructuralPartialEq for DocNode

Auto Trait Implementations§

impl Freeze for DocNode

impl RefUnwindSafe for DocNode

impl Send for DocNode

impl Sync for DocNode

impl Unpin for DocNode

impl UnsafeUnpin for DocNode

impl UnwindSafe for DocNode

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> InitializeFromFunction<T> for T

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

impl<Ret> SpawnIfAsync<(), Ret> for Ret

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block

impl<T, O> SuperFrom<T> for O
where O: From<T>,

fn super_from(input: T) -> O

Convert from a type to another type.

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

fn super_into(self) -> O

Convert from a type to another type.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,