Skip to main content

RdGenerationHeader

Struct RdGenerationHeader 

Source
pub struct RdGenerationHeader<'a> { /* private fields */ }
Expand description

A lossy view of generation header comments at the start of a document.

Source paths borrow the original comment text and retain their spelling, order, and duplicates. They are not normalized, deduplicated, or checked for existence. This deliberately differs from the legacy rd2qmd scanner, which used contains-based matching and looser continuation rules: roxygen2 emits a fixed marker and wraps multi-file lists with % . The source-file lines and continuation rules remain a roxygen-specific convention this view understands.

Near-miss header text is simply not recognized. There is deliberately no inspect_* counterpart because no structural error exists for this view.

Implementations§

Source§

impl<'a> RdGenerationHeader<'a>

Source

pub fn generator(&self) -> Option<&RdGenerator>

Source

pub fn is_generated(&self) -> bool

Source

pub fn source_files(&self) -> &[&'a str]

Source

pub fn has_sources(&self) -> bool

Trait Implementations§

Source§

impl<'a> Clone for RdGenerationHeader<'a>

Source§

fn clone(&self) -> RdGenerationHeader<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for RdGenerationHeader<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for RdGenerationHeader<'a>

Source§

impl<'a> PartialEq for RdGenerationHeader<'a>

Source§

fn eq(&self, other: &RdGenerationHeader<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for RdGenerationHeader<'a>

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> CloneToUninit for T
where T: Clone,

Source§

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
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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.