// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: tools.ozone.setting.listOptions
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct ListOptions<'a> {
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub cursor: std::option::Option<jacquard_common::CowStr<'a>>,
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub keys: std::option::Option<Vec<jacquard_common::types::string::Nsid<'a>>>,
    ///(default: 50, min: 1, max: 100)
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    pub limit: std::option::Option<i64>,
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub prefix: std::option::Option<jacquard_common::CowStr<'a>>,
    ///(default: "instance")
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub scope: std::option::Option<jacquard_common::CowStr<'a>>,
}

pub mod list_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 {}
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {}
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {}
}

/// Builder for constructing an instance of this type
pub struct ListOptionsBuilder<'a, S: list_options_state::State> {
    _phantom_state: ::core::marker::PhantomData<fn() -> S>,
    __unsafe_private_named: (
        ::core::option::Option<jacquard_common::CowStr<'a>>,
        ::core::option::Option<Vec<jacquard_common::types::string::Nsid<'a>>>,
        ::core::option::Option<i64>,
        ::core::option::Option<jacquard_common::CowStr<'a>>,
        ::core::option::Option<jacquard_common::CowStr<'a>>,
    ),
    _phantom: ::core::marker::PhantomData<&'a ()>,
}

impl<'a> ListOptions<'a> {
    /// Create a new builder for this type
    pub fn new() -> ListOptionsBuilder<'a, list_options_state::Empty> {
        ListOptionsBuilder::new()
    }
}

impl<'a> ListOptionsBuilder<'a, list_options_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        ListOptionsBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: (None, None, None, None, None),
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S: list_options_state::State> ListOptionsBuilder<'a, S> {
    /// Set the `cursor` field (optional)
    pub fn cursor(
        mut self,
        value: impl Into<Option<jacquard_common::CowStr<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.0 = value.into();
        self
    }
    /// Set the `cursor` field to an Option value (optional)
    pub fn maybe_cursor(mut self, value: Option<jacquard_common::CowStr<'a>>) -> Self {
        self.__unsafe_private_named.0 = value;
        self
    }
}

impl<'a, S: list_options_state::State> ListOptionsBuilder<'a, S> {
    /// Set the `keys` field (optional)
    pub fn keys(
        mut self,
        value: impl Into<Option<Vec<jacquard_common::types::string::Nsid<'a>>>>,
    ) -> Self {
        self.__unsafe_private_named.1 = value.into();
        self
    }
    /// Set the `keys` field to an Option value (optional)
    pub fn maybe_keys(
        mut self,
        value: Option<Vec<jacquard_common::types::string::Nsid<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.1 = value;
        self
    }
}

impl<'a, S: list_options_state::State> ListOptionsBuilder<'a, S> {
    /// Set the `limit` field (optional)
    pub fn limit(mut self, value: impl Into<Option<i64>>) -> Self {
        self.__unsafe_private_named.2 = value.into();
        self
    }
    /// Set the `limit` field to an Option value (optional)
    pub fn maybe_limit(mut self, value: Option<i64>) -> Self {
        self.__unsafe_private_named.2 = value;
        self
    }
}

impl<'a, S: list_options_state::State> ListOptionsBuilder<'a, S> {
    /// Set the `prefix` field (optional)
    pub fn prefix(
        mut self,
        value: impl Into<Option<jacquard_common::CowStr<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.3 = value.into();
        self
    }
    /// Set the `prefix` field to an Option value (optional)
    pub fn maybe_prefix(mut self, value: Option<jacquard_common::CowStr<'a>>) -> Self {
        self.__unsafe_private_named.3 = value;
        self
    }
}

impl<'a, S: list_options_state::State> ListOptionsBuilder<'a, S> {
    /// Set the `scope` field (optional)
    pub fn scope(
        mut self,
        value: impl Into<Option<jacquard_common::CowStr<'a>>>,
    ) -> Self {
        self.__unsafe_private_named.4 = value.into();
        self
    }
    /// Set the `scope` field to an Option value (optional)
    pub fn maybe_scope(mut self, value: Option<jacquard_common::CowStr<'a>>) -> Self {
        self.__unsafe_private_named.4 = value;
        self
    }
}

impl<'a, S> ListOptionsBuilder<'a, S>
where
    S: list_options_state::State,
{
    /// Build the final struct
    pub fn build(self) -> ListOptions<'a> {
        ListOptions {
            cursor: self.__unsafe_private_named.0,
            keys: self.__unsafe_private_named.1,
            limit: self.__unsafe_private_named.2,
            prefix: self.__unsafe_private_named.3,
            scope: self.__unsafe_private_named.4,
        }
    }
}

#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct ListOptionsOutput<'a> {
    #[serde(skip_serializing_if = "std::option::Option::is_none")]
    #[serde(borrow)]
    pub cursor: std::option::Option<jacquard_common::CowStr<'a>>,
    #[serde(borrow)]
    pub options: Vec<crate::tools_ozone::setting::DefsOption<'a>>,
}

/// Response type for
///tools.ozone.setting.listOptions
pub struct ListOptionsResponse;
impl jacquard_common::xrpc::XrpcResp for ListOptionsResponse {
    const NSID: &'static str = "tools.ozone.setting.listOptions";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = ListOptionsOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for ListOptions<'a> {
    const NSID: &'static str = "tools.ozone.setting.listOptions";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = ListOptionsResponse;
}

/// Endpoint type for
///tools.ozone.setting.listOptions
pub struct ListOptionsRequest;
impl jacquard_common::xrpc::XrpcEndpoint for ListOptionsRequest {
    const PATH: &'static str = "/xrpc/tools.ozone.setting.listOptions";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<'de> = ListOptions<'de>;
    type Response = ListOptionsResponse;
}