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>
impl<'a> RdGenerationHeader<'a>
pub fn generator(&self) -> Option<&RdGenerator>
pub fn is_generated(&self) -> bool
pub fn source_files(&self) -> &[&'a str]
pub fn has_sources(&self) -> bool
Trait Implementations§
Source§impl<'a> Clone for RdGenerationHeader<'a>
impl<'a> Clone for RdGenerationHeader<'a>
Source§fn clone(&self) -> RdGenerationHeader<'a>
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)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<'a> Debug for RdGenerationHeader<'a>
impl<'a> Debug for RdGenerationHeader<'a>
impl<'a> Eq for RdGenerationHeader<'a>
Source§impl<'a> PartialEq for RdGenerationHeader<'a>
impl<'a> PartialEq for RdGenerationHeader<'a>
impl<'a> StructuralPartialEq for RdGenerationHeader<'a>
Auto Trait Implementations§
impl<'a> Freeze for RdGenerationHeader<'a>
impl<'a> RefUnwindSafe for RdGenerationHeader<'a>
impl<'a> Send for RdGenerationHeader<'a>
impl<'a> Sync for RdGenerationHeader<'a>
impl<'a> Unpin for RdGenerationHeader<'a>
impl<'a> UnsafeUnpin for RdGenerationHeader<'a>
impl<'a> UnwindSafe for RdGenerationHeader<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more