jacquard-api 0.12.0-beta.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: blog.pckt.gallery
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::{CowStr, BosStr, DefaultStr, FromStaticStr};

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::collection::{Collection, RecordError};
use jacquard_common::types::string::{AtUri, Cid};
use jacquard_common::types::uri::{RecordUri, UriError};
use jacquard_common::types::value::Data;
use jacquard_common::xrpc::XrpcResp;
use jacquard_derive::{IntoStatic, lexicon};
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Serialize, Deserialize};
use crate::blog_pckt::block::image::ImageAttrs;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "blog.pckt.gallery",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Gallery<S: BosStr = DefaultStr> {
    ///Optional caption for the entire gallery
    #[serde(skip_serializing_if = "Option::is_none")]
    pub caption: Option<S>,
    ///Array of image blocks in display order
    pub images: Vec<ImageAttrs<S>>,
    ///Layout style for rendering the gallery (e.g. grid, carousel, masonry, list)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub layout: Option<S>,
    ///Optional title for the gallery
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Typed wrapper for GetRecord response with this collection's record type.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GalleryGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Gallery<S>,
}

impl<S: BosStr> Gallery<S> {
    pub fn uri(uri: S) -> Result<RecordUri<S, GalleryRecord>, UriError> {
        RecordUri::try_from_uri(AtUri::new(uri)?)
    }
}

/// Marker type for deserializing records from this collection.

#[derive(Debug, Serialize, Deserialize)]
pub struct GalleryRecord;
impl XrpcResp for GalleryRecord {
    const NSID: &'static str = "blog.pckt.gallery";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GalleryGetRecordOutput<S>;
    type Err = RecordError;
}

impl<S: BosStr> From<GalleryGetRecordOutput<S>> for Gallery<S> {
    fn from(output: GalleryGetRecordOutput<S>) -> Self {
        output.value
    }
}

impl<S: BosStr> Collection for Gallery<S> {
    const NSID: &'static str = "blog.pckt.gallery";
    type Record = GalleryRecord;
}

impl Collection for GalleryRecord {
    const NSID: &'static str = "blog.pckt.gallery";
    type Record = GalleryRecord;
}

impl<S: BosStr> LexiconSchema for Gallery<S> {
    fn nsid() -> &'static str {
        "blog.pckt.gallery"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_blog_pckt_gallery()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        if let Some(ref value) = self.caption {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 3000usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("caption"),
                    max: 3000usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        if let Some(ref value) = self.caption {
            {
                let count = UnicodeSegmentation::graphemes(value.as_ref(), true).count();
                if count > 300usize {
                    return Err(ConstraintError::MaxGraphemes {
                        path: ValidationPath::from_field("caption"),
                        max: 300usize,
                        actual: count,
                    });
                }
            }
        }
        {
            let value = &self.images;
            #[allow(unused_comparisons)]
            if value.len() > 50usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("images"),
                    max: 50usize,
                    actual: value.len(),
                });
            }
        }
        {
            let value = &self.images;
            #[allow(unused_comparisons)]
            if value.len() < 1usize {
                return Err(ConstraintError::MinLength {
                    path: ValidationPath::from_field("images"),
                    min: 1usize,
                    actual: value.len(),
                });
            }
        }
        if let Some(ref value) = self.layout {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 50usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("layout"),
                    max: 50usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        if let Some(ref value) = self.title {
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 200usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("title"),
                    max: 200usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

pub mod gallery_state {

    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
    #[allow(unused)]
    use ::core::marker::PhantomData;
    mod sealed {
        pub trait Sealed {}
    }
    /// State trait tracking which required fields have been set
    pub trait State: sealed::Sealed {
        type Images;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Images = Unset;
    }
    ///State transition - sets the `images` field to Set
    pub struct SetImages<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetImages<St> {}
    impl<St: State> State for SetImages<St> {
        type Images = Set<members::images>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `images` field
        pub struct images(());
    }
}

/// Builder for constructing an instance of this type.
pub struct GalleryBuilder<S: BosStr, St: gallery_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<S>, Option<Vec<ImageAttrs<S>>>, Option<S>, Option<S>),
    _type: PhantomData<fn() -> S>,
}

impl<S: BosStr> Gallery<S> {
    /// Create a new builder for this type.
    pub fn new() -> GalleryBuilder<S, gallery_state::Empty> {
        GalleryBuilder::new()
    }
}

impl<S: BosStr> GalleryBuilder<S, gallery_state::Empty> {
    /// Create a new builder with all fields unset.
    pub fn new() -> Self {
        GalleryBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None),
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: gallery_state::State> GalleryBuilder<S, St> {
    /// Set the `caption` field (optional)
    pub fn caption(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `caption` field to an Option value (optional)
    pub fn maybe_caption(mut self, value: Option<S>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<S: BosStr, St> GalleryBuilder<S, St>
where
    St: gallery_state::State,
    St::Images: gallery_state::IsUnset,
{
    /// Set the `images` field (required)
    pub fn images(
        mut self,
        value: impl Into<Vec<ImageAttrs<S>>>,
    ) -> GalleryBuilder<S, gallery_state::SetImages<St>> {
        self._fields.1 = Option::Some(value.into());
        GalleryBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St: gallery_state::State> GalleryBuilder<S, St> {
    /// Set the `layout` field (optional)
    pub fn layout(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `layout` field to an Option value (optional)
    pub fn maybe_layout(mut self, value: Option<S>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<S: BosStr, St: gallery_state::State> GalleryBuilder<S, St> {
    /// Set the `title` field (optional)
    pub fn title(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.3 = value.into();
        self
    }
    /// Set the `title` field to an Option value (optional)
    pub fn maybe_title(mut self, value: Option<S>) -> Self {
        self._fields.3 = value;
        self
    }
}

impl<S: BosStr, St> GalleryBuilder<S, St>
where
    St: gallery_state::State,
    St::Images: gallery_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Gallery<S> {
        Gallery {
            caption: self._fields.0,
            images: self._fields.1.unwrap(),
            layout: self._fields.2,
            title: self._fields.3,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(self, extra_data: BTreeMap<SmolStr, Data<S>>) -> Gallery<S> {
        Gallery {
            caption: self._fields.0,
            images: self._fields.1.unwrap(),
            layout: self._fields.2,
            title: self._fields.3,
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_blog_pckt_gallery() -> LexiconDoc<'static> {
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    use alloc::collections::BTreeMap;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("blog.pckt.gallery"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(vec![SmolStr::new_static("images")]),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("caption"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Optional caption for the entire gallery",
                                        ),
                                    ),
                                    max_length: Some(3000usize),
                                    max_graphemes: Some(300usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("images"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static("Array of image blocks in display order"),
                                    ),
                                    items: LexArrayItem::Ref(LexRef {
                                        r#ref: CowStr::new_static(
                                            "blog.pckt.block.image#imageAttrs",
                                        ),
                                        ..Default::default()
                                    }),
                                    min_length: Some(1usize),
                                    max_length: Some(50usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("layout"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "Layout style for rendering the gallery (e.g. grid, carousel, masonry, list)",
                                        ),
                                    ),
                                    max_length: Some(50usize),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("title"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static("Optional title for the gallery"),
                                    ),
                                    max_length: Some(200usize),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}