pub struct Heading(/* private fields */);Implementations§
Source§impl Heading
impl Heading
Sourcepub fn content(&self) -> String
pub fn content(&self) -> String
Return the visible heading content without its heading delimiters.
Sourcepub fn inlines(&self) -> impl Iterator<Item = Inline> + '_
pub fn inlines(&self) -> impl Iterator<Item = Inline> + '_
Iterate typed inline content in source order.
Sourcepub fn slug(&self) -> String
pub fn slug(&self) -> String
Return the anchor slug Documenter derives from the heading content.
Lowercased, with runs of whitespace collapsed to a single hyphen and every other non-word character dropped. Both the linter’s exemption set and the server’s navigation read anchors through this one definition.
Trait Implementations§
Source§impl AstNode for Heading
impl AstNode for Heading
type Language = DocumentationLanguage
fn can_cast(kind: SyntaxKind) -> bool
fn cast(syntax: SyntaxNode) -> Option<Self>
fn syntax(&self) -> &SyntaxNode
fn clone_subtree(&self) -> Selfwhere
Self: Sized,
impl Eq for Heading
impl StructuralPartialEq for Heading
Auto Trait Implementations§
impl !RefUnwindSafe for Heading
impl !Send for Heading
impl !Sync for Heading
impl !UnwindSafe for Heading
impl Forget for Heading
impl Freeze for Heading
impl Move for Heading
impl Unpin for Heading
impl UnsafeUnpin for Heading
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