jacquard-api 0.12.0-beta.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.gainforest.organization.predictions.fauna
//
// 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::{BosStr, CowStr, DefaultStr, FromStaticStr};

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::collection::{Collection, RecordError};
use jacquard_common::types::string::{AtUri, Cid, Datetime};
use jacquard_common::types::uri::{RecordUri, UriError};
use jacquard_common::types::value::Data;
use jacquard_common::xrpc::XrpcResp;
use jacquard_derive::{IntoStatic, lexicon};
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Deserialize, Serialize};
/// DEPRECATED: Use app.gainforest.dwc.occurrence with basisOfRecord='MachineObservation' instead. A declaration of a fauna prediction for an organization.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    rename = "app.gainforest.organization.predictions.fauna",
    tag = "$type",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct Fauna<S: BosStr = DefaultStr> {
    ///The date and time of the creation of the record
    pub created_at: Datetime,
    ///An array of GBIF taxon keys for each fauna prediction
    pub gbif_taxon_keys: Vec<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Typed wrapper for GetRecord response with this collection's record type.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct FaunaGetRecordOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cid: Option<Cid<S>>,
    pub uri: AtUri<S>,
    pub value: Fauna<S>,
}

impl<S: BosStr> Fauna<S> {
    pub fn uri(uri: S) -> Result<RecordUri<S, FaunaRecord>, UriError> {
        RecordUri::try_from_uri(AtUri::new(uri)?)
    }
}

/// Marker type for deserializing records from this collection.

#[derive(Debug, Serialize, Deserialize)]
pub struct FaunaRecord;
impl XrpcResp for FaunaRecord {
    const NSID: &'static str = "app.gainforest.organization.predictions.fauna";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = FaunaGetRecordOutput<S>;
    type Err = RecordError;
}

impl<S: BosStr> From<FaunaGetRecordOutput<S>> for Fauna<S> {
    fn from(output: FaunaGetRecordOutput<S>) -> Self {
        output.value
    }
}

impl<S: BosStr> Collection for Fauna<S> {
    const NSID: &'static str = "app.gainforest.organization.predictions.fauna";
    type Record = FaunaRecord;
}

impl Collection for FaunaRecord {
    const NSID: &'static str = "app.gainforest.organization.predictions.fauna";
    type Record = FaunaRecord;
}

impl<S: BosStr> LexiconSchema for Fauna<S> {
    fn nsid() -> &'static str {
        "app.gainforest.organization.predictions.fauna"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_app_gainforest_organization_predictions_fauna()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

pub mod fauna_state {

    pub use crate::builder_types::{IsSet, IsUnset, Set, Unset};
    #[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 CreatedAt;
        type GbifTaxonKeys;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type CreatedAt = Unset;
        type GbifTaxonKeys = Unset;
    }
    ///State transition - sets the `created_at` field to Set
    pub struct SetCreatedAt<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetCreatedAt<St> {}
    impl<St: State> State for SetCreatedAt<St> {
        type CreatedAt = Set<members::created_at>;
        type GbifTaxonKeys = St::GbifTaxonKeys;
    }
    ///State transition - sets the `gbif_taxon_keys` field to Set
    pub struct SetGbifTaxonKeys<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetGbifTaxonKeys<St> {}
    impl<St: State> State for SetGbifTaxonKeys<St> {
        type CreatedAt = St::CreatedAt;
        type GbifTaxonKeys = Set<members::gbif_taxon_keys>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `created_at` field
        pub struct created_at(());
        ///Marker type for the `gbif_taxon_keys` field
        pub struct gbif_taxon_keys(());
    }
}

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

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

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

impl<S: BosStr, St> FaunaBuilder<S, St>
where
    St: fauna_state::State,
    St::CreatedAt: fauna_state::IsUnset,
{
    /// Set the `createdAt` field (required)
    pub fn created_at(
        mut self,
        value: impl Into<Datetime>,
    ) -> FaunaBuilder<S, fauna_state::SetCreatedAt<St>> {
        self._fields.0 = Option::Some(value.into());
        FaunaBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> FaunaBuilder<S, St>
where
    St: fauna_state::State,
    St::GbifTaxonKeys: fauna_state::IsUnset,
{
    /// Set the `gbifTaxonKeys` field (required)
    pub fn gbif_taxon_keys(
        mut self,
        value: impl Into<Vec<S>>,
    ) -> FaunaBuilder<S, fauna_state::SetGbifTaxonKeys<St>> {
        self._fields.1 = Option::Some(value.into());
        FaunaBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> FaunaBuilder<S, St>
where
    St: fauna_state::State,
    St::CreatedAt: fauna_state::IsSet,
    St::GbifTaxonKeys: fauna_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> Fauna<S> {
        Fauna {
            created_at: self._fields.0.unwrap(),
            gbif_taxon_keys: 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>>) -> Fauna<S> {
        Fauna {
            created_at: self._fields.0.unwrap(),
            gbif_taxon_keys: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_app_gainforest_organization_predictions_fauna() -> LexiconDoc<'static> {
    use alloc::collections::BTreeMap;
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("app.gainforest.organization.predictions.fauna"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Record(LexRecord {
                    description: Some(
                        CowStr::new_static(
                            "DEPRECATED: Use app.gainforest.dwc.occurrence with basisOfRecord='MachineObservation' instead. A declaration of a fauna prediction for an organization.",
                        ),
                    ),
                    key: Some(CowStr::new_static("tid")),
                    record: LexRecordRecord::Object(LexObject {
                        required: Some(
                            vec![
                                SmolStr::new_static("gbifTaxonKeys"),
                                SmolStr::new_static("createdAt")
                            ],
                        ),
                        properties: {
                            #[allow(unused_mut)]
                            let mut map = BTreeMap::new();
                            map.insert(
                                SmolStr::new_static("createdAt"),
                                LexObjectProperty::String(LexString {
                                    description: Some(
                                        CowStr::new_static(
                                            "The date and time of the creation of the record",
                                        ),
                                    ),
                                    format: Some(LexStringFormat::Datetime),
                                    ..Default::default()
                                }),
                            );
                            map.insert(
                                SmolStr::new_static("gbifTaxonKeys"),
                                LexObjectProperty::Array(LexArray {
                                    description: Some(
                                        CowStr::new_static(
                                            "An array of GBIF taxon keys for each fauna prediction",
                                        ),
                                    ),
                                    items: LexArrayItem::String(LexString {
                                        description: Some(
                                            CowStr::new_static(
                                                "The GBIF taxon key of the fauna prediction",
                                            ),
                                        ),
                                        ..Default::default()
                                    }),
                                    ..Default::default()
                                }),
                            );
                            map
                        },
                        ..Default::default()
                    }),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}