Struct LexiconDoc 

pub struct LexiconDoc {
    pub lexicon: u32,
    pub id: String,
    pub description: Option<String>,
    pub defs: Map<String, Value>,
}

A lexicon document as published under lexicons/.

Fields

lexicon: u32

Lexicon language version. Always 1 today.

id: String

The NSID this document defines.

Checked against nsid_syntax::validate while deserializing, so a LexiconDoc that exists at all names something that could be a lexicon somewhere in atproto. Upstream’s lexicon-invalid.json carries "id": "one-two-three" for exactly this.

description: Option<String>

Human-readable description of the document as a whole.

defs: Map<String, Value>

The definitions in this document, keyed by name. main is the primary.

Implementations

impl LexiconDoc

pub fn main(&self) -> Option<&Value>

The primary definition, if this document has one.

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

The type of the primary definition, for example record or query.

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

The record key strategy, for a document whose primary def is a record.

Trait Implementations

impl Clone for LexiconDoc

fn clone(&self) -> LexiconDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LexiconDoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LexiconDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.