Struct Document 

pub struct Document<'a> {

    pub bsky_post_ref: Option<StrongRef<'a>>,
    pub content: Option<Content<'a>>,
    pub cover_image: Option<BlobRef<'a>>,
    pub description: Option<CowStr<'a>>,
    pub path: Option<CowStr<'a>>,
    pub preferences: Option<Preferences<'a>>,
    pub published_at: Datetime,
    pub site: UriValue<'a>,
    pub tags: Option<Vec<CowStr<'a>>>,
    pub text_content: Option<CowStr<'a>>,
    pub theme: Option<Theme<'a>>,
    pub title: CowStr<'a>,
    pub updated_at: Option<Datetime>,
    pub extra_data: Option<BTreeMap<SmolStr, Data<'a>>>,
}

Fields

bsky_post_ref: Option<StrongRef<'a>>

content: Option<Content<'a>>

cover_image: Option<BlobRef<'a>>

description: Option<CowStr<'a>>

path: Option<CowStr<'a>>

combine with the publication url or the document site to construct a full url to the document

preferences: Option<Preferences<'a>>

published_at: Datetime

site: UriValue<'a>

URI to the site or publication this document belongs to. Supports both AT-URIs (at://did/collection/rkey) for publication references and HTTPS URLs (https://example.com) for standalone documents or external sites.

tags: Option<Vec<CowStr<'a>>>

text_content: Option<CowStr<'a>>

theme: Option<Theme<'a>>

Theme for standalone documents. For documents in publications, theme is inherited from the publication.

title: CowStr<'a>

updated_at: Option<Datetime>

extra_data: Option<BTreeMap<SmolStr, Data<'a>>>

Implementations

impl<'a> Document<'a>

pub fn uri( uri: impl Into<CowStr<'a>>, ) -> Result<RecordUri<'a, DocumentRecord>, UriError>

impl<'a> Document<'a>

pub fn new() -> DocumentBuilder<'a, Empty>

Create a new builder for this type

Trait Implementations

impl<'a> Clone for Document<'a>

fn clone(&self) -> Document<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Collection for Document<'_>

const NSID: &'static str = "site.standard.document"

The NSID for the Lexicon that defines the schema of records in this collection.

type Record = DocumentRecord

A marker type implementing XrpcResp that allows typed deserialization of records from this collection. Used by AgentSessionExt::get_record to return properly typed responses.

fn nsid() -> Nsid<'static>

Returns the Nsid for the Lexicon that defines the schema of records in this collection.

fn repo_path<'u, T>(rkey: &'u RecordKey<T>) -> RepoPath<'u>

where T: RecordKeyType,

Returns the repo path for a record in this collection with the given record key.

impl<'a> Debug for Document<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Document<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DocumentGetRecordOutput<'_>> for Document<'_>

fn from(output: DocumentGetRecordOutput<'_>) -> Self

Converts to this type from the input type.

impl<'a> IntoStatic for Document<'a>

type Output = Document<'static>

The “owned” variant of the type. For Cow<'a, str>, this is Cow<'static, str>, for example.

fn into_static(self) -> Self::Output

Turns the value into an “owned” variant, which can then be returned, moved, etc.

impl<'a> LexiconSchema for Document<'a>

fn nsid() -> &'static str

The NSID for this type’s primary definition

fn def_name() -> &'static str

The definition name within the lexicon document

fn lexicon_doc() -> LexiconDoc<'static>

Generate the lexicon document for this type

fn validate(&self) -> Result<(), ConstraintError>

Validate an instance against lexicon constraints

fn schema_id() -> CowStr<'static>

The schema ID for this type

fn inline_schema() -> bool

Whether this type should be inlined vs referenced

impl<'a> PartialEq for Document<'a>

fn eq(&self, other: &Document<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for Document<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Document<'a>

impl<'a> StructuralPartialEq for Document<'a>