jacquard-api 0.12.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.bsky.unspecced.searchActorsSkeleton
//
// 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::string::Did;
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, open_union};
use serde::{Serialize, Deserialize};
use crate::app_bsky::unspecced::SkeletonSearchActor;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct SearchActorsSkeleton<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>,
    pub q: S,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub typeahead: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub viewer: Option<Did<S>>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct SearchActorsSkeletonOutput<S: BosStr = DefaultStr> {
    pub actors: Vec<SkeletonSearchActor<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<S>,
    ///Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hits_total: Option<i64>,
    #[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 SearchActorsSkeletonError {
    #[serde(rename = "BadQueryString")]
    BadQueryString(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for SearchActorsSkeletonError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::BadQueryString(msg) => {
                write!(f, "BadQueryString")?;
                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 `app.bsky.unspecced.searchActorsSkeleton` query.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `SearchActorsSkeletonOutput<S>` for this endpoint.*/
pub struct SearchActorsSkeletonResponse;
impl jacquard_common::xrpc::XrpcResp for SearchActorsSkeletonResponse {
    const NSID: &'static str = "app.bsky.unspecced.searchActorsSkeleton";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = SearchActorsSkeletonOutput<S>;
    type Err = SearchActorsSkeletonError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for SearchActorsSkeleton<S> {
    const NSID: &'static str = "app.bsky.unspecced.searchActorsSkeleton";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = SearchActorsSkeletonResponse;
}

/** Endpoint marker for the `app.bsky.unspecced.searchActorsSkeleton` query.

Path: `/xrpc/app.bsky.unspecced.searchActorsSkeleton`. The request payload type is `SearchActorsSkeleton<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct SearchActorsSkeletonRequest;
impl jacquard_common::xrpc::XrpcEndpoint for SearchActorsSkeletonRequest {
    const PATH: &'static str = "/xrpc/app.bsky.unspecced.searchActorsSkeleton";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = SearchActorsSkeleton<S>;
    type Response = SearchActorsSkeletonResponse;
}

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

pub mod search_actors_skeleton_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 SearchActorsSkeletonBuilder<
    St: search_actors_skeleton_state::State,
    S: BosStr = DefaultStr,
> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<S>, Option<i64>, Option<S>, Option<bool>, Option<Did<S>>),
    _type: PhantomData<fn() -> S>,
}

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

impl<S: BosStr> SearchActorsSkeleton<S> {
    /// Create a new builder for this type
    pub fn builder() -> SearchActorsSkeletonBuilder<
        search_actors_skeleton_state::Empty,
        S,
    > {
        SearchActorsSkeletonBuilder::builder()
    }
}

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

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

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

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

impl<
    St: search_actors_skeleton_state::State,
    S: BosStr,
> SearchActorsSkeletonBuilder<St, S> {
    /// Set the `viewer` field (optional)
    pub fn viewer(mut self, value: impl Into<Option<Did<S>>>) -> Self {
        self._fields.4 = value.into();
        self
    }
    /// Set the `viewer` field to an Option value (optional)
    pub fn maybe_viewer(mut self, value: Option<Did<S>>) -> Self {
        self._fields.4 = value;
        self
    }
}

impl<St, S: BosStr> SearchActorsSkeletonBuilder<St, S>
where
    St: search_actors_skeleton_state::State,
    St::Q: search_actors_skeleton_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> SearchActorsSkeleton<S> {
        SearchActorsSkeleton {
            cursor: self._fields.0,
            limit: self._fields.1,
            q: self._fields.2.unwrap(),
            typeahead: self._fields.3,
            viewer: self._fields.4,
        }
    }
}