jacquard-api 0.11.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: social.showcase.collection.listCollections
//
// 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;
use jacquard_common::types::ident::AtIdentifier;
use jacquard_derive::{IntoStatic, lexicon};
use serde::{Serialize, Deserialize};
use crate::social_showcase::CollectionView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct ListCollections<'a> {
    #[serde(borrow)]
    pub actor: AtIdentifier<'a>,
    ///(max length: 512)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cursor: Option<CowStr<'a>>,
    ///Defaults to `50`. Min: 1. Max: 100.
    #[serde(default = "_default_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct ListCollectionsOutput<'a> {
    #[serde(borrow)]
    pub collections: Vec<CollectionView<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cursor: Option<CowStr<'a>>,
}

/// Response type for social.showcase.collection.listCollections
pub struct ListCollectionsResponse;
impl jacquard_common::xrpc::XrpcResp for ListCollectionsResponse {
    const NSID: &'static str = "social.showcase.collection.listCollections";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = ListCollectionsOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for ListCollections<'a> {
    const NSID: &'static str = "social.showcase.collection.listCollections";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = ListCollectionsResponse;
}

/// Endpoint type for social.showcase.collection.listCollections
pub struct ListCollectionsRequest;
impl jacquard_common::xrpc::XrpcEndpoint for ListCollectionsRequest {
    const PATH: &'static str = "/xrpc/social.showcase.collection.listCollections";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<'de> = ListCollections<'de>;
    type Response = ListCollectionsResponse;
}

fn _default_limit() -> Option<i64> {
    Some(50i64)
}

pub mod list_collections_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 Actor;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Actor = Unset;
    }
    ///State transition - sets the `actor` field to Set
    pub struct SetActor<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetActor<S> {}
    impl<S: State> State for SetActor<S> {
        type Actor = Set<members::actor>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `actor` field
        pub struct actor(());
    }
}

/// Builder for constructing an instance of this type
pub struct ListCollectionsBuilder<'a, S: list_collections_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (Option<AtIdentifier<'a>>, Option<CowStr<'a>>, Option<i64>),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> ListCollections<'a> {
    /// Create a new builder for this type
    pub fn new() -> ListCollectionsBuilder<'a, list_collections_state::Empty> {
        ListCollectionsBuilder::new()
    }
}

impl<'a> ListCollectionsBuilder<'a, list_collections_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        ListCollectionsBuilder {
            _state: PhantomData,
            _fields: (None, None, None),
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> ListCollectionsBuilder<'a, S>
where
    S: list_collections_state::State,
    S::Actor: list_collections_state::IsUnset,
{
    /// Set the `actor` field (required)
    pub fn actor(
        mut self,
        value: impl Into<AtIdentifier<'a>>,
    ) -> ListCollectionsBuilder<'a, list_collections_state::SetActor<S>> {
        self._fields.0 = Option::Some(value.into());
        ListCollectionsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S: list_collections_state::State> ListCollectionsBuilder<'a, S> {
    /// Set the `cursor` field (optional)
    pub fn cursor(mut self, value: impl Into<Option<CowStr<'a>>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `cursor` field to an Option value (optional)
    pub fn maybe_cursor(mut self, value: Option<CowStr<'a>>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<'a, S: list_collections_state::State> ListCollectionsBuilder<'a, S> {
    /// Set the `limit` field (optional)
    pub fn limit(mut self, value: impl Into<Option<i64>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `limit` field to an Option value (optional)
    pub fn maybe_limit(mut self, value: Option<i64>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<'a, S> ListCollectionsBuilder<'a, S>
where
    S: list_collections_state::State,
    S::Actor: list_collections_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> ListCollections<'a> {
        ListCollections {
            actor: self._fields.0.unwrap(),
            cursor: self._fields.1,
            limit: self._fields.2,
        }
    }
}