Struct Catalog 

pub struct Catalog {
    pub catalog_schema: u32,
    pub topics: Vec<Topic>,
}

The whole catalog, parsed.

Fields

catalog_schema: u32

Always SCHEMA once parsed.

topics: Vec<Topic>

Every topic, in authored order.

Implementations

impl Catalog

pub fn parse(bytes: &[u8]) -> Result<Self, CatalogError>

Read one catalog.

Errors

CatalogError when the bytes do not parse or the schema is one this engine does not read.

pub fn for_document(&self, on: ShelfId, wanted: &str) -> Option<&Topic>

The topic serving one shelf document, where the catalog has one.

pub fn resolve(&self, query: &str) -> Result<&Topic, Unresolved>

Turn one query into exactly one topic.

The order is exact id, then exact alias, then a case-folded prefix over both. An ambiguous query names every candidate rather than picking one, because a reader who asked loosely gets a shorter list and never a document they did not mean.

Errors

Unresolved naming either the candidates or the nearest ids.

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Catalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Catalog

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Catalog

impl PartialEq for Catalog

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Catalog

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Catalog