Struct RdDoc 

pub struct RdDoc {

    pub name: Option<String>,
    pub aliases: Vec<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub usage: Option<String>,
    pub arguments: Vec<(String, String)>,
    pub value: Option<String>,
    pub examples: Option<String>,
    pub seealso: Option<String>,
    pub doc_type: Option<String>,
    pub keywords: Vec<String>,
    pub author: Option<String>,
    pub details: Option<String>,
    pub note: Option<String>,
    pub references: Option<String>,
    pub sections: Vec<(String, String)>,
}

A parsed R documentation file.

Contains the extracted metadata and section content from an .Rd file. Text content has markup stripped to produce plain-text representations suitable for terminal display.

Fields

name: Option<String>

The documented object’s name (\name{}).

aliases: Vec<String>

Topic aliases that resolve to this doc page (\alias{}).

title: Option<String>

Short one-line title (\title{}).

description: Option<String>

Description section (\description{}).

usage: Option<String>

Usage examples showing function signatures (\usage{}).

arguments: Vec<(String, String)>

Argument descriptions (\arguments{}), keyed by parameter name.

value: Option<String>

Return value description (\value{}).

examples: Option<String>

Runnable examples (\examples{}).

seealso: Option<String>

See-also cross-references (\seealso{}).

doc_type: Option<String>

Document type (\docType{}), e.g. “package”, “data”, “class”.

keywords: Vec<String>

Keywords (\keyword{}).

author: Option<String>

Author information (\author{}).

details: Option<String>

Details section (\details{}).

note: Option<String>

Note section (\note{}).

references: Option<String>

References section (\references{}).

sections: Vec<(String, String)>

Named custom sections (\section{Name}{...}).

Implementations

impl RdDoc

pub fn parse(input: &str) -> Result<Self, RdError>

Parse an Rd document from its text content.

pub fn parse_file(path: &Path) -> Result<Self, RdError>

Parse an Rd file from disk.

pub fn format_text(&self) -> String

Format the document as plain text for terminal display.

pub fn examples_code(&self) -> Option<&str>

Extract the examples section as runnable R code.

Returns None if no examples section exists. The returned code has \dontrun{} blocks removed and \donttest{} / \dontshow{} blocks unwrapped (their content is included).

pub fn to_rd(&self) -> String

Serialize this document to R’s .Rd format.

Produces a well-formed Rd file that can be placed in a package’s man/ directory. Text content is escaped so that %, {, }, and \ in user-facing strings don’t break Rd parsing, while Rd structural commands are emitted verbatim.

Trait Implementations

impl Clone for RdDoc

fn clone(&self) -> RdDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RdDoc

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

Formats the value using the given formatter.

impl Default for RdDoc

fn default() -> RdDoc

Returns the “default value” for a type.

impl PartialEq for RdDoc

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

impl StructuralPartialEq for RdDoc