Enum DocumentAddress 

pub enum DocumentAddress {
    Markdown {
        path: String,
        origin: MarkdownOrigin,
    },
    Manual {
        name: String,
        manual_section: String,
    },
}

Stable selector for one discoverable document candidate.

Variants

Markdown

A Markdown document registered in the document catalog.

Fields

path: String

Extension-free path relative to the selected Markdown origin.

origin: MarkdownOrigin

Storage namespace containing the relative path.

Manual

An installed native manual page.

Fields

name: String

Manual topic without its section suffix.

manual_section: String

Native manual category such as 1 or 3p.

Implementations

impl DocumentAddress

pub fn name(&self) -> &str

Return the basename used as the document’s short lookup name.

pub fn relative_path(&self) -> String

Stable path relative to its storage namespace.

pub fn catalog_path(&self) -> String

Complete, unambiguous path in ManT’s unified document tree.

Trait Implementations

impl Clone for DocumentAddress

fn clone(&self) -> DocumentAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentAddress

fn deserialize<__D>( __deserializer: __D, ) -> Result<DocumentAddress, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DocumentAddress

impl JsonSchema for DocumentAddress

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for DocumentAddress

fn cmp(&self, other: &DocumentAddress) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DocumentAddress

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DocumentAddress

fn partial_cmp(&self, other: &DocumentAddress) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DocumentAddress

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DocumentAddress