Enum RdNode 

#[non_exhaustive]
pub enum RdNode {
    Text(String),
    RCode(String),
    Verb(String),
    Comment(String),
    Tagged(RdTagged),
    Group(RdGroup),
    Raw(RawRdNode),
}

A single node of an Rd document tree.

The design is mostly generic: four leaf kinds carry raw text, one variant (Tagged) represents every known markup macro uniformly via RdTag, and Raw is the lossless fallback for anything that doesn’t fit. See the crate-level documentation for why semantics (link targets, argument pairing, table rows) are intentionally left out of this enum.

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.

Text(String)

A TEXT-tagged leaf: plain documentation text.

RCode(String)

An RCODE-tagged leaf: R source code, as found inside \usage, \examples, and similar code-valued sections/macros.

Verb(String)

A VERB-tagged leaf: verbatim text, as found inside \verb{...} and \preformatted{...}.

Comment(String)

A COMMENT-tagged leaf: a %-introduced Rd comment, preserved (including the leading %) rather than dropped, since parse_Rd(keep.source = TRUE) keeps them and a lossless AST must be able to represent whatever the producer handed it.

Tagged(RdTagged)

Any node carrying a known or unknown macro-style Rd_tag.

Group(RdGroup)

An untagged positional-argument group.

Raw(RawRdNode)

A lossless fallback for a node that doesn’t fit the shapes above: genuinely non-canonical structures such as nodes with unexpected attributes. Positional-argument groups use RdNode::Group.

Implementations

impl RdNode

pub fn tagged( tag: RdTag, option: Option<Vec<RdNode>>, children: Vec<RdNode>, ) -> Self

pub fn group(children: Vec<RdNode>) -> Self

pub fn as_tagged(&self) -> Option<&RdTagged>

pub fn as_group(&self) -> Option<&RdGroup>

pub fn as_raw(&self) -> Option<&RawRdNode>

pub fn into_tagged(self) -> Result<RdTagged, Self>

pub fn into_group(self) -> Result<RdGroup, Self>

pub fn into_raw(self) -> Result<RawRdNode, Self>

impl RdNode

pub fn conditional(&self, base_path: &RdPath) -> Option<RdConditional<'_>>

pub fn inspect_conditional( &self, base_path: &RdPath, ) -> Result<Option<RdConditional<'_>>, RdShapeError>

impl RdNode

pub fn enc(&self, base_path: &RdPath) -> Option<RdEnc<'_>>

pub fn inspect_enc( &self, base_path: &RdPath, ) -> Result<Option<RdEnc<'_>>, RdShapeError>

impl RdNode

pub fn example_control( &self, base_path: &RdPath, ) -> Option<RdExampleControl<'_>>

Lossily views a canonical example-control wrapper without an option.

pub fn inspect_example_control( &self, base_path: &RdPath, ) -> Result<Option<RdExampleControl<'_>>, RdShapeError>

Strictly inspects a canonical example-control wrapper without changing or validating any of its direct children.

impl RdNode

pub fn figure(&self, base_path: &RdPath) -> Option<RdFigure<'_>>

pub fn inspect_figure( &self, base_path: &RdPath, ) -> Result<Option<RdFigure<'_>>, RdShapeError>

impl RdNode

pub fn inline_span(&self, base_path: &RdPath) -> Option<RdInlineSpan<'_>>

pub fn inspect_inline_span( &self, base_path: &RdPath, ) -> Result<Option<RdInlineSpan<'_>>, RdShapeError>

impl RdNode

pub fn text_symbol(&self, base_path: &RdPath) -> Option<RdTextSymbol>

pub fn inspect_text_symbol( &self, base_path: &RdPath, ) -> Result<Option<RdTextSymbol>, RdShapeError>

impl RdNode

pub fn s4_class_link(&self, base_path: &RdPath) -> Option<RdS4ClassLink<'_>>

pub fn inspect_s4_class_link( &self, base_path: &RdPath, ) -> Result<Option<RdS4ClassLink<'_>>, RdShapeError>

impl RdNode

pub fn method(&self, base_path: &RdPath) -> Option<RdMethod<'_>>

pub fn inspect_method( &self, base_path: &RdPath, ) -> Result<Option<RdMethod<'_>>, RdShapeError>

Trait Implementations

impl Clone for RdNode

fn clone(&self) -> RdNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RdNode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RdNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RdNode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RdNode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RdNode