jacquard-api 0.12.0

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.media.getVideoList
//
// 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};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, open_union};
use serde::{Serialize, Deserialize};
use crate::place_stream::media::get_video::VideoView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetVideoList<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<S>,
    /// Defaults to `25`. Min: 1. Max: 100.
    #[serde(default = "_default_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repo: Option<S>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetVideoListOutput<S: BosStr = DefaultStr> {
    ///Pagination cursor for the next page, if any.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<S>,
    pub videos: Vec<VideoView<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(
    Serialize,
    Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    thiserror::Error,
    miette::Diagnostic
)]

#[serde(tag = "error", content = "message")]
pub enum GetVideoListError {
    /// No repo indexed at the supplied DID.
    #[serde(rename = "RepoNotFound")]
    RepoNotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for GetVideoListError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::RepoNotFound(msg) => {
                write!(f, "RepoNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::Other { error, message } => {
                write!(f, "{}", error)?;
                if let Some(msg) = message {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
        }
    }
}

/** Response marker for the `place.stream.media.getVideoList` query.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `GetVideoListOutput<S>` for this endpoint.*/
pub struct GetVideoListResponse;
impl jacquard_common::xrpc::XrpcResp for GetVideoListResponse {
    const NSID: &'static str = "place.stream.media.getVideoList";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetVideoListOutput<S>;
    type Err = GetVideoListError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetVideoList<S> {
    const NSID: &'static str = "place.stream.media.getVideoList";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetVideoListResponse;
}

/** Endpoint marker for the `place.stream.media.getVideoList` query.

Path: `/xrpc/place.stream.media.getVideoList`. The request payload type is `GetVideoList<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct GetVideoListRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetVideoListRequest {
    const PATH: &'static str = "/xrpc/place.stream.media.getVideoList";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetVideoList<S>;
    type Response = GetVideoListResponse;
}

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

pub mod get_video_list_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 {}
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {}
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {}
}

/// Builder for constructing an instance of this type.
pub struct GetVideoListBuilder<St: get_video_list_state::State, S: BosStr = DefaultStr> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<S>, Option<i64>, Option<S>),
    _type: PhantomData<fn() -> S>,
}

impl GetVideoList<DefaultStr> {
    /// Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed
    pub fn new() -> GetVideoListBuilder<get_video_list_state::Empty, DefaultStr> {
        GetVideoListBuilder::new()
    }
}

impl<S: BosStr> GetVideoList<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetVideoListBuilder<get_video_list_state::Empty, S> {
        GetVideoListBuilder::builder()
    }
}

impl GetVideoListBuilder<get_video_list_state::Empty, DefaultStr> {
    /// Create a new builder with all fields unset, using the default string type, if needed
    pub fn new() -> Self {
        GetVideoListBuilder {
            _state: PhantomData,
            _fields: (None, None, None),
            _type: PhantomData,
        }
    }
}

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

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

impl<St: get_video_list_state::State, S: BosStr> GetVideoListBuilder<St, S> {
    /// Set the `limit` field (optional)
    pub fn limit(mut self, value: impl Into<Option<i64>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `limit` field to an Option value (optional)
    pub fn maybe_limit(mut self, value: Option<i64>) -> Self {
        self._fields.1 = value;
        self
    }
}

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

impl<St, S: BosStr> GetVideoListBuilder<St, S>
where
    St: get_video_list_state::State,
{
    /// Build the final struct.
    pub fn build(self) -> GetVideoList<S> {
        GetVideoList {
            cursor: self._fields.0,
            limit: self._fields.1,
            repo: self._fields.2,
        }
    }
}