jacquard-api 0.12.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.game.search
//
// 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::games_gamesgamesgamesgames::CollectionSummaryView;
use crate::games_gamesgamesgamesgames::EngineSummaryView;
use crate::games_gamesgamesgamesgames::GameSummaryView;
use crate::games_gamesgamesgamesgames::PlatformSummaryView;
use crate::games_gamesgamesgamesgames::ProfileSummaryView;

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


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct SearchOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<S>,
    pub results: Vec<SearchOutputResultsItem<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total_results: Option<i64>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[open_union]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(tag = "$type", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub enum SearchOutputResultsItem<S: BosStr = DefaultStr> {
    #[serde(rename = "games.gamesgamesgamesgames.defs#gameSummaryView")]
    GameSummaryView(Box<GameSummaryView<S>>),
    #[serde(rename = "games.gamesgamesgamesgames.defs#profileSummaryView")]
    ProfileSummaryView(Box<ProfileSummaryView<S>>),
    #[serde(rename = "games.gamesgamesgamesgames.defs#platformSummaryView")]
    PlatformSummaryView(Box<PlatformSummaryView<S>>),
    #[serde(rename = "games.gamesgamesgamesgames.defs#collectionSummaryView")]
    CollectionSummaryView(Box<CollectionSummaryView<S>>),
    #[serde(rename = "games.gamesgamesgamesgames.defs#engineSummaryView")]
    EngineSummaryView(Box<EngineSummaryView<S>>),
}

/** Response marker for the `place.stream.game.search` query.

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

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for Search<S> {
    const NSID: &'static str = "place.stream.game.search";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = SearchResponse;
}

/** Endpoint marker for the `place.stream.game.search` query.

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

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

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

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

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

impl<S: BosStr> Search<S> {
    /// Create a new builder for this type
    pub fn builder() -> SearchBuilder<search_state::Empty, S> {
        SearchBuilder::builder()
    }
}

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

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

impl<St: search_state::State, S: BosStr> SearchBuilder<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: search_state::State, S: BosStr> SearchBuilder<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, S: BosStr> SearchBuilder<St, S>
where
    St: search_state::State,
    St::Q: search_state::IsUnset,
{
    /// Set the `q` field (required)
    pub fn q(mut self, value: impl Into<S>) -> SearchBuilder<search_state::SetQ<St>, S> {
        self._fields.2 = Option::Some(value.into());
        SearchBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> SearchBuilder<St, S>
where
    St: search_state::State,
    St::Q: search_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Search<S> {
        Search {
            cursor: self._fields.0,
            limit: self._fields.1,
            q: self._fields.2.unwrap(),
        }
    }
}