Struct HelpMetadata

Source

pub struct HelpMetadata {
    pub links: Vec<HelpLink>,
    pub anchors: Vec<HelpAnchor>,
}

Expand description

M.3.2.c.5: parsed-out metadata that travels alongside a freshly-constructed HelpBuffer. Bundles the data the help-mode owns per-buffer so the App can seed it into buffer_locals[id] at popup-open time. Replaces the links / anchors / highlights fields that used to live directly on HelpBuffer.

Fields§

§links: Vec<HelpLink>

[label](url) links extracted by the from_lines parser, indexed against the cleaned (post-link-strip) text.

§anchors: Vec<HelpAnchor>

Named anchors – heading slugs auto-generated by generate_heading_anchors, plus any explicit anchors supplied by the introspection renderer.

HelpMetadata

Struct HelpMetadata Copy item path

Fields§

Trait Implementations§

impl Clone for HelpMetadata

fn clone(&self) -> HelpMetadata

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

impl Debug for HelpMetadata

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

impl Default for HelpMetadata

fn default() -> HelpMetadata

Auto Trait Implementations§

impl Freeze for HelpMetadata

impl RefUnwindSafe for HelpMetadata

impl Send for HelpMetadata

impl Sync for HelpMetadata

impl Unpin for HelpMetadata

impl UnsafeUnpin for HelpMetadata

impl UnwindSafe for HelpMetadata

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Struct HelpMetadata

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,