Struct ItemDoc 

pub struct ItemDoc {
    pub text: Option<&'static str>,
    pub offset: u32,
    pub len: u32,
}

Static text plus an optional span of the compressed doc blob.

text is a plain docstring, a full name(sig)\n--\n\nbody literal, or only the signature prefix when len is the database body.

Fields

text: Option<&'static str>

offset: u32

len: u32

Implementations

impl ItemDoc

pub const NONE: Self

pub const EMPTY: Self

An explicit empty docstring. offset == u32::MAX distinguishes it from NONE, which means the item has no docstring at all.

pub const fn static_text(text: &'static str) -> Self

pub const fn is_db(self) -> bool

pub const fn db(key: &str) -> Self

Database entry key. Evaluate it in a const so the lookup table is not linked into the binary.

Trait Implementations

impl Clone for ItemDoc

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ItemDoc

impl Debug for ItemDoc

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

Formats the value using the given formatter.

impl Default for ItemDoc

fn default() -> Self

Returns the “default value” for a type.