jacquard-api 0.12.0-beta.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: tools.ozone.setting.removeOptions
//
// 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::Nsid;
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 RemoveOptions<S: BosStr = DefaultStr> {
    pub keys: Vec<Nsid<S>>,
    pub scope: RemoveOptionsScope<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum RemoveOptionsScope<S: BosStr = DefaultStr> {
    Instance,
    Personal,
    Other(S),
}

impl<S: BosStr> RemoveOptionsScope<S> {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Instance => "instance",
            Self::Personal => "personal",
            Self::Other(s) => s.as_ref(),
        }
    }
    /// Construct from a string-like value, matching known values.
    pub fn from_value(s: S) -> Self {
        match s.as_ref() {
            "instance" => Self::Instance,
            "personal" => Self::Personal,
            _ => Self::Other(s),
        }
    }
}

impl<S: BosStr> core::fmt::Display for RemoveOptionsScope<S> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl<S: BosStr> AsRef<str> for RemoveOptionsScope<S> {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl<S: BosStr> Serialize for RemoveOptionsScope<S> {
    fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
    where
        Ser: serde::Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de, S: Deserialize<'de> + BosStr> Deserialize<'de> for RemoveOptionsScope<S> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = S::deserialize(deserializer)?;
        Ok(Self::from_value(s))
    }
}

impl<S: BosStr + Default> Default for RemoveOptionsScope<S> {
    fn default() -> Self {
        Self::Other(Default::default())
    }
}

impl<S: BosStr> jacquard_common::IntoStatic for RemoveOptionsScope<S>
where
    S: BosStr + jacquard_common::IntoStatic,
    S::Output: BosStr,
{
    type Output = RemoveOptionsScope<S::Output>;
    fn into_static(self) -> Self::Output {
        match self {
            RemoveOptionsScope::Instance => RemoveOptionsScope::Instance,
            RemoveOptionsScope::Personal => RemoveOptionsScope::Personal,
            RemoveOptionsScope::Other(v) => RemoveOptionsScope::Other(v.into_static()),
        }
    }
}


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

/// Response type for tools.ozone.setting.removeOptions
pub struct RemoveOptionsResponse;
impl jacquard_common::xrpc::XrpcResp for RemoveOptionsResponse {
    const NSID: &'static str = "tools.ozone.setting.removeOptions";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = RemoveOptionsOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for RemoveOptions<S> {
    const NSID: &'static str = "tools.ozone.setting.removeOptions";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = RemoveOptionsResponse;
}

/// Endpoint type for tools.ozone.setting.removeOptions
pub struct RemoveOptionsRequest;
impl jacquard_common::xrpc::XrpcEndpoint for RemoveOptionsRequest {
    const PATH: &'static str = "/xrpc/tools.ozone.setting.removeOptions";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = RemoveOptions<S>;
    type Response = RemoveOptionsResponse;
}

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

/// Builder for constructing an instance of this type.
pub struct RemoveOptionsBuilder<S: BosStr, St: remove_options_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<Vec<Nsid<S>>>, Option<RemoveOptionsScope<S>>),
    _type: PhantomData<fn() -> S>,
}

impl<S: BosStr> RemoveOptions<S> {
    /// Create a new builder for this type.
    pub fn new() -> RemoveOptionsBuilder<S, remove_options_state::Empty> {
        RemoveOptionsBuilder::new()
    }
}

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

impl<S: BosStr, St> RemoveOptionsBuilder<S, St>
where
    St: remove_options_state::State,
    St::Keys: remove_options_state::IsUnset,
{
    /// Set the `keys` field (required)
    pub fn keys(
        mut self,
        value: impl Into<Vec<Nsid<S>>>,
    ) -> RemoveOptionsBuilder<S, remove_options_state::SetKeys<St>> {
        self._fields.0 = Option::Some(value.into());
        RemoveOptionsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> RemoveOptionsBuilder<S, St>
where
    St: remove_options_state::State,
    St::Scope: remove_options_state::IsUnset,
{
    /// Set the `scope` field (required)
    pub fn scope(
        mut self,
        value: impl Into<RemoveOptionsScope<S>>,
    ) -> RemoveOptionsBuilder<S, remove_options_state::SetScope<St>> {
        self._fields.1 = Option::Some(value.into());
        RemoveOptionsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> RemoveOptionsBuilder<S, St>
where
    St: remove_options_state::State,
    St::Scope: remove_options_state::IsSet,
    St::Keys: remove_options_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> RemoveOptions<S> {
        RemoveOptions {
            keys: self._fields.0.unwrap(),
            scope: self._fields.1.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> RemoveOptions<S> {
        RemoveOptions {
            keys: self._fields.0.unwrap(),
            scope: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}