jacquard-api 0.11.1

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.weaver.notebook.searchNotebooks
//
// 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;
use jacquard_common::types::ident::AtIdentifier;
use jacquard_derive::{IntoStatic, lexicon};
use serde::{Serialize, Deserialize};
use crate::sh_weaver::notebook::NotebookView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct SearchNotebooks<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub author: Option<AtIdentifier<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cursor: Option<CowStr<'a>>,
    ///Defaults to `25`. Min: 1. Max: 100.
    #[serde(default = "_default_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    #[serde(borrow)]
    pub q: CowStr<'a>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub rating: Option<Vec<CowStr<'a>>>,
    ///Defaults to `"relevance"`.
    #[serde(default = "_default_sort")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub sort: Option<CowStr<'a>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub tags: Option<Vec<CowStr<'a>>>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct SearchNotebooksOutput<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub cursor: Option<CowStr<'a>>,
    #[serde(borrow)]
    pub notebooks: Vec<NotebookView<'a>>,
}

/// Response type for sh.weaver.notebook.searchNotebooks
pub struct SearchNotebooksResponse;
impl jacquard_common::xrpc::XrpcResp for SearchNotebooksResponse {
    const NSID: &'static str = "sh.weaver.notebook.searchNotebooks";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = SearchNotebooksOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for SearchNotebooks<'a> {
    const NSID: &'static str = "sh.weaver.notebook.searchNotebooks";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = SearchNotebooksResponse;
}

/// Endpoint type for sh.weaver.notebook.searchNotebooks
pub struct SearchNotebooksRequest;
impl jacquard_common::xrpc::XrpcEndpoint for SearchNotebooksRequest {
    const PATH: &'static str = "/xrpc/sh.weaver.notebook.searchNotebooks";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<'de> = SearchNotebooks<'de>;
    type Response = SearchNotebooksResponse;
}

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

fn _default_sort() -> Option<CowStr<'static>> {
    Some(CowStr::from("relevance"))
}

pub mod search_notebooks_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<S: State = Empty>(PhantomData<fn() -> S>);
    impl<S: State> sealed::Sealed for SetQ<S> {}
    impl<S: State> State for SetQ<S> {
        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 SearchNotebooksBuilder<'a, S: search_notebooks_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (
        Option<AtIdentifier<'a>>,
        Option<CowStr<'a>>,
        Option<i64>,
        Option<CowStr<'a>>,
        Option<Vec<CowStr<'a>>>,
        Option<CowStr<'a>>,
        Option<Vec<CowStr<'a>>>,
    ),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> SearchNotebooks<'a> {
    /// Create a new builder for this type
    pub fn new() -> SearchNotebooksBuilder<'a, search_notebooks_state::Empty> {
        SearchNotebooksBuilder::new()
    }
}

impl<'a> SearchNotebooksBuilder<'a, search_notebooks_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn new() -> Self {
        SearchNotebooksBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None, None, None, None),
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S: search_notebooks_state::State> SearchNotebooksBuilder<'a, S> {
    /// Set the `author` field (optional)
    pub fn author(mut self, value: impl Into<Option<AtIdentifier<'a>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `author` field to an Option value (optional)
    pub fn maybe_author(mut self, value: Option<AtIdentifier<'a>>) -> Self {
        self._fields.0 = value;
        self
    }
}

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

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

impl<'a, S> SearchNotebooksBuilder<'a, S>
where
    S: search_notebooks_state::State,
    S::Q: search_notebooks_state::IsUnset,
{
    /// Set the `q` field (required)
    pub fn q(
        mut self,
        value: impl Into<CowStr<'a>>,
    ) -> SearchNotebooksBuilder<'a, search_notebooks_state::SetQ<S>> {
        self._fields.3 = Option::Some(value.into());
        SearchNotebooksBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S: search_notebooks_state::State> SearchNotebooksBuilder<'a, S> {
    /// Set the `rating` field (optional)
    pub fn rating(mut self, value: impl Into<Option<Vec<CowStr<'a>>>>) -> Self {
        self._fields.4 = value.into();
        self
    }
    /// Set the `rating` field to an Option value (optional)
    pub fn maybe_rating(mut self, value: Option<Vec<CowStr<'a>>>) -> Self {
        self._fields.4 = value;
        self
    }
}

impl<'a, S: search_notebooks_state::State> SearchNotebooksBuilder<'a, S> {
    /// Set the `sort` field (optional)
    pub fn sort(mut self, value: impl Into<Option<CowStr<'a>>>) -> Self {
        self._fields.5 = value.into();
        self
    }
    /// Set the `sort` field to an Option value (optional)
    pub fn maybe_sort(mut self, value: Option<CowStr<'a>>) -> Self {
        self._fields.5 = value;
        self
    }
}

impl<'a, S: search_notebooks_state::State> SearchNotebooksBuilder<'a, S> {
    /// Set the `tags` field (optional)
    pub fn tags(mut self, value: impl Into<Option<Vec<CowStr<'a>>>>) -> Self {
        self._fields.6 = value.into();
        self
    }
    /// Set the `tags` field to an Option value (optional)
    pub fn maybe_tags(mut self, value: Option<Vec<CowStr<'a>>>) -> Self {
        self._fields.6 = value;
        self
    }
}

impl<'a, S> SearchNotebooksBuilder<'a, S>
where
    S: search_notebooks_state::State,
    S::Q: search_notebooks_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> SearchNotebooks<'a> {
        SearchNotebooks {
            author: self._fields.0,
            cursor: self._fields.1,
            limit: self._fields.2,
            q: self._fields.3.unwrap(),
            rating: self._fields.4,
            sort: self._fields.5,
            tags: self._fields.6,
        }
    }
}