Struct HelpTopicEntry 

#[non_exhaustive]
pub struct HelpTopicEntry {
    pub aliases: Vec<Option<String>>,
    pub name: HelpTopicText,
    pub title: HelpTopicText,
    pub file: HelpTopicText,
}

One row of Meta/Rd.rds, in stored order.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aliases: Vec<Option<String>>

Aliases in stored order, including duplicates and R NA as None.

name: HelpTopicText

The optional Name value, preserved exactly as decoded.

title: HelpTopicText

The optional Title value. No whitespace normalization is applied.

file: HelpTopicText

The optional File value, preserved exactly as decoded.

Implementations

impl HelpTopicEntry

pub fn topic_key(&self) -> Option<&str>

Derives the help-database key from the basename of Self::file, removing one trailing .Rd or .rd suffix as R does. Trailing path separators are ignored. The stored file value is unchanged, and an empty basename yields an empty key. This does not establish that a corresponding topic exists in the help database.

Trait Implementations

impl Clone for HelpTopicEntry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpTopicEntry

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

Formats the value using the given formatter.

impl Eq for HelpTopicEntry

impl PartialEq for HelpTopicEntry

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HelpTopicEntry