Skip to main content

HelpTopicBody

Enum HelpTopicBody 

Source
pub enum HelpTopicBody {
    Static(&'static str),
    Owned(String),
    Compressed {
        packed: &'static [u8],
        raw_len: usize,
        cache: OnceLock<String>,
    },
    Dynamic(Box<dyn Fn() -> String + Send + Sync>),
}
Expand description

Where a topic’s body comes from.

  • Static — a compile-time &'static str. Used by tests and by any caller registering a topic from a string it already holds.
  • Owned — runtime markdown the registry owns. What a plugin’s pages land as (CR.3): the body crossed the WASM boundary as an owned String and there is no 'static to borrow from. Chosen over leaking the string — a leak would survive unload, and a plugin reloaded repeatedly would accumulate a copy of its manual each time.
  • Compressed — deflate-compressed markdown embedded at build time. Every builtin topic is one of these. Decompressed on first render and cached, so a session that never opens :help never decompresses anything and the second open of a topic is free.
  • Dynamic — a closure invoked on every open (the seam for LSP / introspection). NOT what plugin pages use: it re-invokes on every open, and a help plugin’s guest is dropped once its bodies are across.

Variants§

§

Static(&'static str)

§

Owned(String)

§

Compressed

Fields

§packed: &'static [u8]

Raw deflate stream (no zlib/gzip wrapper).

§raw_len: usize

Decompressed length, used to size the output buffer exactly.

§cache: OnceLock<String>

Decompressed body, filled on first HelpTopicBody::render.

§

Dynamic(Box<dyn Fn() -> String + Send + Sync>)

Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.
§

impl<T> WithSubscriber for T

§

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

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more