jacquard-api 0.10.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: network.slices.slice.stats
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct CollectionStats<'a> {
    ///Collection NSID
    #[serde(borrow)]
    pub collection: jacquard_common::types::string::Nsid<'a>,
    ///Number of records in this collection
    pub record_count: i64,
    ///Number of unique actors with records in this collection
    pub unique_actors: i64,
}

pub mod collection_stats_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 Collection;
        type UniqueActors;
        type RecordCount;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Collection = Unset;
        type UniqueActors = Unset;
        type RecordCount = Unset;
    }
    ///State transition - sets the `collection` field to Set
    pub struct SetCollection<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetCollection<S> {}
    impl<S: State> State for SetCollection<S> {
        type Collection = Set<members::collection>;
        type UniqueActors = S::UniqueActors;
        type RecordCount = S::RecordCount;
    }
    ///State transition - sets the `unique_actors` field to Set
    pub struct SetUniqueActors<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetUniqueActors<S> {}
    impl<S: State> State for SetUniqueActors<S> {
        type Collection = S::Collection;
        type UniqueActors = Set<members::unique_actors>;
        type RecordCount = S::RecordCount;
    }
    ///State transition - sets the `record_count` field to Set
    pub struct SetRecordCount<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetRecordCount<S> {}
    impl<S: State> State for SetRecordCount<S> {
        type Collection = S::Collection;
        type UniqueActors = S::UniqueActors;
        type RecordCount = Set<members::record_count>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `collection` field
        pub struct collection(());
        ///Marker type for the `unique_actors` field
        pub struct unique_actors(());
        ///Marker type for the `record_count` field
        pub struct record_count(());
    }
}

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

impl<'a> CollectionStats<'a> {
    /// Create a new builder for this type
    pub fn new() -> CollectionStatsBuilder<'a, collection_stats_state::Empty> {
        CollectionStatsBuilder::new()
    }
}

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

impl<'a, S> CollectionStatsBuilder<'a, S>
where
    S: collection_stats_state::State,
    S::Collection: collection_stats_state::IsUnset,
{
    /// Set the `collection` field (required)
    pub fn collection(
        mut self,
        value: impl Into<jacquard_common::types::string::Nsid<'a>>,
    ) -> CollectionStatsBuilder<'a, collection_stats_state::SetCollection<S>> {
        self.__unsafe_private_named.0 = ::core::option::Option::Some(value.into());
        CollectionStatsBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> CollectionStatsBuilder<'a, S>
where
    S: collection_stats_state::State,
    S::RecordCount: collection_stats_state::IsUnset,
{
    /// Set the `recordCount` field (required)
    pub fn record_count(
        mut self,
        value: impl Into<i64>,
    ) -> CollectionStatsBuilder<'a, collection_stats_state::SetRecordCount<S>> {
        self.__unsafe_private_named.1 = ::core::option::Option::Some(value.into());
        CollectionStatsBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> CollectionStatsBuilder<'a, S>
where
    S: collection_stats_state::State,
    S::UniqueActors: collection_stats_state::IsUnset,
{
    /// Set the `uniqueActors` field (required)
    pub fn unique_actors(
        mut self,
        value: impl Into<i64>,
    ) -> CollectionStatsBuilder<'a, collection_stats_state::SetUniqueActors<S>> {
        self.__unsafe_private_named.2 = ::core::option::Option::Some(value.into());
        CollectionStatsBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> CollectionStatsBuilder<'a, S>
where
    S: collection_stats_state::State,
    S::Collection: collection_stats_state::IsSet,
    S::UniqueActors: collection_stats_state::IsSet,
    S::RecordCount: collection_stats_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> CollectionStats<'a> {
        CollectionStats {
            collection: self.__unsafe_private_named.0.unwrap(),
            record_count: self.__unsafe_private_named.1.unwrap(),
            unique_actors: self.__unsafe_private_named.2.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data
    pub fn build_with_data(
        self,
        extra_data: std::collections::BTreeMap<
            jacquard_common::deps::smol_str::SmolStr,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> CollectionStats<'a> {
        CollectionStats {
            collection: self.__unsafe_private_named.0.unwrap(),
            record_count: self.__unsafe_private_named.1.unwrap(),
            unique_actors: self.__unsafe_private_named.2.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_network_slices_slice_stats() -> ::jacquard_lexicon::lexicon::LexiconDoc<
    'static,
> {
    ::jacquard_lexicon::lexicon::LexiconDoc {
        lexicon: ::jacquard_lexicon::lexicon::Lexicon::Lexicon1,
        id: ::jacquard_common::CowStr::new_static("network.slices.slice.stats"),
        revision: None,
        description: None,
        defs: {
            let mut map = ::alloc::collections::BTreeMap::new();
            map.insert(
                ::jacquard_common::deps::smol_str::SmolStr::new_static(
                    "collectionStats",
                ),
                ::jacquard_lexicon::lexicon::LexUserType::Object(::jacquard_lexicon::lexicon::LexObject {
                    description: None,
                    required: Some(
                        vec![
                            ::jacquard_common::deps::smol_str::SmolStr::new_static("collection"),
                            ::jacquard_common::deps::smol_str::SmolStr::new_static("recordCount"),
                            ::jacquard_common::deps::smol_str::SmolStr::new_static("uniqueActors")
                        ],
                    ),
                    nullable: None,
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = ::alloc::collections::BTreeMap::new();
                        map.insert(
                            ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                "collection",
                            ),
                            ::jacquard_lexicon::lexicon::LexObjectProperty::String(::jacquard_lexicon::lexicon::LexString {
                                description: Some(
                                    ::jacquard_common::CowStr::new_static("Collection NSID"),
                                ),
                                format: Some(
                                    ::jacquard_lexicon::lexicon::LexStringFormat::Nsid,
                                ),
                                default: None,
                                min_length: None,
                                max_length: None,
                                min_graphemes: None,
                                max_graphemes: None,
                                r#enum: None,
                                r#const: None,
                                known_values: None,
                            }),
                        );
                        map.insert(
                            ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                "recordCount",
                            ),
                            ::jacquard_lexicon::lexicon::LexObjectProperty::Integer(::jacquard_lexicon::lexicon::LexInteger {
                                description: None,
                                default: None,
                                minimum: None,
                                maximum: None,
                                r#enum: None,
                                r#const: None,
                            }),
                        );
                        map.insert(
                            ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                "uniqueActors",
                            ),
                            ::jacquard_lexicon::lexicon::LexObjectProperty::Integer(::jacquard_lexicon::lexicon::LexInteger {
                                description: None,
                                default: None,
                                minimum: None,
                                maximum: None,
                                r#enum: None,
                                r#const: None,
                            }),
                        );
                        map
                    },
                }),
            );
            map.insert(
                ::jacquard_common::deps::smol_str::SmolStr::new_static("main"),
                ::jacquard_lexicon::lexicon::LexUserType::XrpcQuery(::jacquard_lexicon::lexicon::LexXrpcQuery {
                    description: None,
                    parameters: Some(
                        ::jacquard_lexicon::lexicon::LexXrpcQueryParameter::Params(::jacquard_lexicon::lexicon::LexXrpcParameters {
                            description: None,
                            required: Some(
                                vec![
                                    ::jacquard_common::deps::smol_str::SmolStr::new_static("slice")
                                ],
                            ),
                            properties: {
                                #[allow(unused_mut)]
                                let mut map = ::alloc::collections::BTreeMap::new();
                                map.insert(
                                    ::jacquard_common::deps::smol_str::SmolStr::new_static(
                                        "slice",
                                    ),
                                    ::jacquard_lexicon::lexicon::LexXrpcParametersProperty::String(::jacquard_lexicon::lexicon::LexString {
                                        description: Some(
                                            ::jacquard_common::CowStr::new_static(
                                                "AT-URI of the slice to get statistics for",
                                            ),
                                        ),
                                        format: None,
                                        default: None,
                                        min_length: None,
                                        max_length: None,
                                        min_graphemes: None,
                                        max_graphemes: None,
                                        r#enum: None,
                                        r#const: None,
                                        known_values: None,
                                    }),
                                );
                                map
                            },
                        }),
                    ),
                    output: None,
                    errors: None,
                }),
            );
            map
        },
    }
}

impl<'a> ::jacquard_lexicon::schema::LexiconSchema for CollectionStats<'a> {
    fn nsid() -> &'static str {
        "network.slices.slice.stats"
    }
    fn def_name() -> &'static str {
        "collectionStats"
    }
    fn lexicon_doc() -> ::jacquard_lexicon::lexicon::LexiconDoc<'static> {
        lexicon_doc_network_slices_slice_stats()
    }
    fn validate(
        &self,
    ) -> ::core::result::Result<(), ::jacquard_lexicon::validation::ConstraintError> {
        Ok(())
    }
}

#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct Stats<'a> {
    #[serde(borrow)]
    pub slice: jacquard_common::CowStr<'a>,
}

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

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

impl<'a> Stats<'a> {
    /// Create a new builder for this type
    pub fn new() -> StatsBuilder<'a, stats_state::Empty> {
        StatsBuilder::new()
    }
}

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

impl<'a, S> StatsBuilder<'a, S>
where
    S: stats_state::State,
    S::Slice: stats_state::IsUnset,
{
    /// Set the `slice` field (required)
    pub fn slice(
        mut self,
        value: impl Into<jacquard_common::CowStr<'a>>,
    ) -> StatsBuilder<'a, stats_state::SetSlice<S>> {
        self.__unsafe_private_named.0 = ::core::option::Option::Some(value.into());
        StatsBuilder {
            _phantom_state: ::core::marker::PhantomData,
            __unsafe_private_named: self.__unsafe_private_named,
            _phantom: ::core::marker::PhantomData,
        }
    }
}

impl<'a, S> StatsBuilder<'a, S>
where
    S: stats_state::State,
    S::Slice: stats_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> Stats<'a> {
        Stats {
            slice: self.__unsafe_private_named.0.unwrap(),
        }
    }
}

#[jacquard_derive::lexicon]
#[derive(
    serde::Serialize,
    serde::Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    jacquard_derive::IntoStatic
)]
#[serde(rename_all = "camelCase")]
pub struct StatsOutput<'a> {
    ///Per-collection statistics
    #[serde(borrow)]
    pub collection_stats: Vec<crate::network_slices::slice::stats::CollectionStats<'a>>,
    ///List of collection NSIDs indexed in this slice
    #[serde(borrow)]
    pub collections: Vec<jacquard_common::types::string::Nsid<'a>>,
    ///Total number of unique actors indexed in this slice
    pub total_actors: i64,
    ///Total number of lexicons defined for this slice
    pub total_lexicons: i64,
    ///Total number of records indexed in this slice
    pub total_records: i64,
}

/// Response type for
///network.slices.slice.stats
pub struct StatsResponse;
impl jacquard_common::xrpc::XrpcResp for StatsResponse {
    const NSID: &'static str = "network.slices.slice.stats";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = StatsOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for Stats<'a> {
    const NSID: &'static str = "network.slices.slice.stats";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = StatsResponse;
}

/// Endpoint type for
///network.slices.slice.stats
pub struct StatsRequest;
impl jacquard_common::xrpc::XrpcEndpoint for StatsRequest {
    const PATH: &'static str = "/xrpc/network.slices.slice.stats";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<'de> = Stats<'de>;
    type Response = StatsResponse;
}