Enum QueryError 

pub enum QueryError {
    EmptyName,
    InvalidManualSection,
    TldrManualSection {
        section: String,
    },
    InvalidSource,
    ConflictingSourceSelectors,
    EmptyMarkdownPath,
    UnsupportedInputFormat {
        path: String,
    },
    EmptySelection,
    TooManySelections {
        maximum: usize,
    },
    EmptySelector,
    InvalidEntryKinds,
    EmptyEntry,
    InvalidViewSelector {
        field: &'static str,
        error: ScopeTextError,
    },
    InvalidSearch(SearchError),
    Markdown {
        path: String,
        detail: String,
    },
    EmptyMarkdown {
        label: String,
    },
    Registry {
        detail: String,
    },
    Manual(ManualLoadError),
    ManualWithTldr {
        error: ManualLoadError,
        topic: String,
    },
    TldrNotFound {
        topic: String,
    },
    Tldr {
        topic: String,
        detail: String,
    },
    NoReadableContent {
        name: String,
    },
}

A query cannot produce either authoritative manual content or a quick reference.

Variants

EmptyName

A document selector was empty after trimming.

InvalidManualSection

A native manual category was empty or malformed.

TldrManualSection

A tldr command query was qualified by a non-command manual section.

Fields

section: String

Incompatible native manual section.

InvalidSource

An explicit Markdown source name was empty.

ConflictingSourceSelectors

Markdown-source and native-manual selectors were combined.

EmptyMarkdownPath

A direct Markdown input path was empty.

UnsupportedInputFormat

Automatic format inference did not recognize a direct input.

Fields

path: String

Caller-facing input path.

EmptySelection

Excerpt projection was requested without selectors.

TooManySelections

Excerpt projection exceeded the closed selector-count bound.

Fields

maximum: usize

Maximum selectors accepted by one focused request.

EmptySelector

An excerpt selector was empty.

InvalidEntryKinds

A role-filtered outline contained no kinds or exceeded the closed kind family.

EmptyEntry

An explanation entry name was empty.

InvalidViewSelector

A node or semantic-entry selector violated the bounded request contract.

Fields

field: &'static str

User-facing field name.

error: ScopeTextError

Precise bound or character violation.

InvalidSearch(SearchError)

Search configuration failed validation.

Markdown

Markdown input could not be read or parsed.

Fields

path: String

Caller-facing source path.

detail: String

Stable failure detail.

EmptyMarkdown

Markdown parsing produced neither document nor tldr content.

Fields

label: String

Selected-document label.

Registry

Registered-document discovery failed.

Fields

detail: String

Stable source-configuration or discovery detail.

Manual(ManualLoadError)

Native manual loading failed.

ManualWithTldr

No full document was found, but an optional tldr entry is available.

Fields

error: ManualLoadError

Native-manual failure retained as the authoritative lookup error.

topic: String

Topic that can be queried explicitly with --tldr.

TldrNotFound

An explicit tldr query found no quick-reference candidate.

Fields

topic: String

Requested tldr topic.

Tldr

An explicit tldr candidate could not be read or parsed.

Fields

topic: String

Requested tldr topic.

detail: String

Stable cache or Markdown failure detail.

NoReadableContent

No Markdown, manual, or quick-reference content could be resolved.

Fields

name: String

Requested document name.

Trait Implementations

impl Clone for QueryError

fn clone(&self) -> QueryError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryError

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

Formats the value using the given formatter.

impl Display for QueryError

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

Formats the value using the given formatter.

impl Eq for QueryError

impl Error for QueryError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for QueryError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for QueryError