jacquard-api 0.12.0

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

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetVideoPlaylist<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sid: Option<S>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub track: Option<S>,
    pub uri: AtUri<S>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetVideoPlaylistOutput {
    pub body: Bytes,
}


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

#[serde(tag = "error", content = "message")]
pub enum GetVideoPlaylistError {
    /// No record indexed at the supplied AT-URI.
    #[serde(rename = "VideoNotFound")]
    VideoNotFound(Option<SmolStr>),
    /// The requested track ID is not present in the video's blob.
    #[serde(rename = "TrackNotFound")]
    TrackNotFound(Option<SmolStr>),
    /// The record references a blob this node hasn't indexed an origin for.
    #[serde(rename = "BlobNotFound")]
    BlobNotFound(Option<SmolStr>),
    /// The AT-URI points at a collection this endpoint doesn't know how to play back.
    #[serde(rename = "UnsupportedCollection")]
    UnsupportedCollection(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for GetVideoPlaylistError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::VideoNotFound(msg) => {
                write!(f, "VideoNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::TrackNotFound(msg) => {
                write!(f, "TrackNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::BlobNotFound(msg) => {
                write!(f, "BlobNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::UnsupportedCollection(msg) => {
                write!(f, "UnsupportedCollection")?;
                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.playback.getVideoPlaylist` query.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `GetVideoPlaylistOutput` for this endpoint.*/
pub struct GetVideoPlaylistResponse;
impl jacquard_common::xrpc::XrpcResp for GetVideoPlaylistResponse {
    const NSID: &'static str = "place.stream.playback.getVideoPlaylist";
    const ENCODING: &'static str = "*/*";
    type Output<S: BosStr> = GetVideoPlaylistOutput;
    type Err = GetVideoPlaylistError;
    fn encode_output<S: BosStr>(
        output: &Self::Output<S>,
    ) -> Result<Vec<u8>, jacquard_common::xrpc::EncodeError>
    where
        Self::Output<S>: Serialize,
    {
        Ok(output.body.to_vec())
    }
    fn decode_output<'de, S>(
        body: &'de [u8],
    ) -> Result<Self::Output<S>, jacquard_common::error::DecodeError>
    where
        S: BosStr + Deserialize<'de>,
        Self::Output<S>: Deserialize<'de>,
    {
        Ok(GetVideoPlaylistOutput {
            body: jacquard_common::deps::bytes::Bytes::copy_from_slice(body),
        })
    }
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetVideoPlaylist<S> {
    const NSID: &'static str = "place.stream.playback.getVideoPlaylist";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetVideoPlaylistResponse;
}

/** Endpoint marker for the `place.stream.playback.getVideoPlaylist` query.

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

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

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

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

impl<S: BosStr> GetVideoPlaylist<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetVideoPlaylistBuilder<get_video_playlist_state::Empty, S> {
        GetVideoPlaylistBuilder::builder()
    }
}

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

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

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

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

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

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

impl<St, S: BosStr> GetVideoPlaylistBuilder<St, S>
where
    St: get_video_playlist_state::State,
    St::Uri: get_video_playlist_state::IsUnset,
{
    /// Set the `uri` field (required)
    pub fn uri(
        mut self,
        value: impl Into<AtUri<S>>,
    ) -> GetVideoPlaylistBuilder<get_video_playlist_state::SetUri<St>, S> {
        self._fields.4 = Option::Some(value.into());
        GetVideoPlaylistBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> GetVideoPlaylistBuilder<St, S>
where
    St: get_video_playlist_state::State,
    St::Uri: get_video_playlist_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetVideoPlaylist<S> {
        GetVideoPlaylist {
            end: self._fields.0,
            sid: self._fields.1,
            start: self._fields.2,
            track: self._fields.3,
            uri: self._fields.4.unwrap(),
        }
    }
}