Struct ParseOptions 

#[non_exhaustive]
pub struct ParseOptions {
    pub roxygen_markdown_default: bool,
}

Options controlling a parse. Construct via Default and set the fields you need — the struct is #[non_exhaustive], so new options can be added without a breaking change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

roxygen_markdown_default: bool

The markdown mode of a roxygen block carrying no @md/@noMd directive of its own (a block’s directive always wins, last one in the block winning — roxygen2’s block-level toggle).

Off means Rd-first, matching parse and roxygen2’s loose-file default. Since roxygen2 8.0.0 packages normally enable markdown package-wide (Config/roxygen2/markdown in DESCRIPTION, or the older Roxygen: list(markdown = TRUE) field) rather than writing per-block @md, so a caller processing such a package should set this to true. Discovering the setting from DESCRIPTION is the caller’s job — this crate never does file I/O beyond the text it is handed.

Implementations

impl ParseOptions

pub fn with_roxygen_markdown_default(self, on: bool) -> Self

Builder-style setter for roxygen_markdown_default: the struct is #[non_exhaustive], so outside this crate ParseOptions::default().with_roxygen_markdown_default(true) is the way to construct an options value with markdown on.

Trait Implementations

impl Clone for ParseOptions

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 ParseOptions

impl Debug for ParseOptions

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

Formats the value using the given formatter.

impl Default for ParseOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ParseOptions

impl Hash for ParseOptions

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 PartialEq for ParseOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ParseOptions