Struct DocumentBuilder 

pub struct DocumentBuilder<'a, S: State> { /* private fields */ }

Builder for constructing an instance of this type

Implementations

impl<'a> DocumentBuilder<'a, Empty>

pub fn new() -> Self

Create a new builder with all fields unset

impl<'a, S> DocumentBuilder<'a, S>

where S: State, S::Author: IsUnset,

pub fn author( self, value: impl Into<AtIdentifier<'a>>, ) -> DocumentBuilder<'a, SetAuthor<S>>

Set the author field (required)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn cover_image(self, value: impl Into<Option<BlobRef<'a>>>) -> Self

Set the coverImage field (optional)

pub fn maybe_cover_image(self, value: Option<BlobRef<'a>>) -> Self

Set the coverImage field to an Option value (optional)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn description(self, value: impl Into<Option<CowStr<'a>>>) -> Self

Set the description field (optional)

pub fn maybe_description(self, value: Option<CowStr<'a>>) -> Self

Set the description field to an Option value (optional)

impl<'a, S> DocumentBuilder<'a, S>

where S: State, S::Pages: IsUnset,

pub fn pages( self, value: impl Into<Vec<DocumentPagesItem<'a>>>, ) -> DocumentBuilder<'a, SetPages<S>>

Set the pages field (required)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn post_ref(self, value: impl Into<Option<StrongRef<'a>>>) -> Self

Set the postRef field (optional)

pub fn maybe_post_ref(self, value: Option<StrongRef<'a>>) -> Self

Set the postRef field to an Option value (optional)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn preferences(self, value: impl Into<Option<Preferences<'a>>>) -> Self

Set the preferences field (optional)

pub fn maybe_preferences(self, value: Option<Preferences<'a>>) -> Self

Set the preferences field to an Option value (optional)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn publication(self, value: impl Into<Option<AtUri<'a>>>) -> Self

Set the publication field (optional)

pub fn maybe_publication(self, value: Option<AtUri<'a>>) -> Self

Set the publication field to an Option value (optional)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn published_at(self, value: impl Into<Option<Datetime>>) -> Self

Set the publishedAt field (optional)

pub fn maybe_published_at(self, value: Option<Datetime>) -> Self

Set the publishedAt field to an Option value (optional)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn tags(self, value: impl Into<Option<Vec<CowStr<'a>>>>) -> Self

Set the tags field (optional)

pub fn maybe_tags(self, value: Option<Vec<CowStr<'a>>>) -> Self

Set the tags field to an Option value (optional)

impl<'a, S: State> DocumentBuilder<'a, S>

pub fn theme(self, value: impl Into<Option<Theme<'a>>>) -> Self

Set the theme field (optional)

pub fn maybe_theme(self, value: Option<Theme<'a>>) -> Self

Set the theme field to an Option value (optional)

impl<'a, S> DocumentBuilder<'a, S>

where S: State, S::Title: IsUnset,

pub fn title( self, value: impl Into<CowStr<'a>>, ) -> DocumentBuilder<'a, SetTitle<S>>

Set the title field (required)

impl<'a, S> DocumentBuilder<'a, S>

where S: State, S::Title: IsSet, S::Author: IsSet, S::Pages: IsSet,

pub fn build(self) -> Document<'a>

Build the final struct

pub fn build_with_data( self, extra_data: BTreeMap<SmolStr, Data<'a>>, ) -> Document<'a>

Build the final struct with custom extra_data