jacquard-api 0.12.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.playback.getPlaybackServer
//
// 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;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetPlaybackServer<S: BosStr = DefaultStr> {
    pub stream: S,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetPlaybackServerOutput<S: BosStr = DefaultStr> {
    ///List of available playback server addresses
    pub servers: Vec<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 GetPlaybackServerError {
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

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

/** Response marker for the `place.stream.playback.getPlaybackServer` query.

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

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

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

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

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

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

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

impl<S: BosStr> GetPlaybackServer<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetPlaybackServerBuilder<get_playback_server_state::Empty, S> {
        GetPlaybackServerBuilder::builder()
    }
}

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

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

impl<St, S: BosStr> GetPlaybackServerBuilder<St, S>
where
    St: get_playback_server_state::State,
    St::Stream: get_playback_server_state::IsUnset,
{
    /// Set the `stream` field (required)
    pub fn stream(
        mut self,
        value: impl Into<S>,
    ) -> GetPlaybackServerBuilder<get_playback_server_state::SetStream<St>, S> {
        self._fields.0 = Option::Some(value.into());
        GetPlaybackServerBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> GetPlaybackServerBuilder<St, S>
where
    St: get_playback_server_state::State,
    St::Stream: get_playback_server_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetPlaybackServer<S> {
        GetPlaybackServer {
            stream: self._fields.0.unwrap(),
        }
    }
}