jacquard-api 0.12.0-beta.2

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: science.alt.dataset.storageHttp
//
// 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, DefaultStr, FromStaticStr};

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::UriValue;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

use crate::science_alt::dataset::entry::ShardChecksum;
use crate::science_alt::dataset::storage_http;
#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Deserialize, Serialize};
/// HTTP/HTTPS storage for WebDataset tar archives. Each shard is listed individually with a checksum for integrity verification. Consumers build brace-expansion patterns on the fly when needed.

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct StorageHttp<S: BosStr = DefaultStr> {
    ///Array of shard entries with URL and integrity checksum
    pub shards: Vec<storage_http::ShardEntry<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// A single HTTP-accessible shard with integrity checksum

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct ShardEntry<S: BosStr = DefaultStr> {
    ///Content hash for integrity verification
    pub checksum: ShardChecksum<S>,
    ///HTTP/HTTPS URL for this WebDataset tar shard
    pub url: UriValue<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

impl<S: BosStr> LexiconSchema for StorageHttp<S> {
    fn nsid() -> &'static str {
        "science.alt.dataset.storageHttp"
    }
    fn def_name() -> &'static str {
        "main"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_science_alt_dataset_storageHttp()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        {
            let value = &self.shards;
            #[allow(unused_comparisons)]
            if value.len() < 1usize {
                return Err(ConstraintError::MinLength {
                    path: ValidationPath::from_field("shards"),
                    min: 1usize,
                    actual: value.len(),
                });
            }
        }
        Ok(())
    }
}

impl<S: BosStr> LexiconSchema for ShardEntry<S> {
    fn nsid() -> &'static str {
        "science.alt.dataset.storageHttp"
    }
    fn def_name() -> &'static str {
        "shardEntry"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_science_alt_dataset_storageHttp()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        {
            let value = &self.url;
            #[allow(unused_comparisons)]
            if <str>::len(value.as_ref()) > 2000usize {
                return Err(ConstraintError::MaxLength {
                    path: ValidationPath::from_field("url"),
                    max: 2000usize,
                    actual: <str>::len(value.as_ref()),
                });
            }
        }
        Ok(())
    }
}

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

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

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

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

impl<S: BosStr, St> StorageHttpBuilder<S, St>
where
    St: storage_http_state::State,
    St::Shards: storage_http_state::IsUnset,
{
    /// Set the `shards` field (required)
    pub fn shards(
        mut self,
        value: impl Into<Vec<storage_http::ShardEntry<S>>>,
    ) -> StorageHttpBuilder<S, storage_http_state::SetShards<St>> {
        self._fields.0 = Option::Some(value.into());
        StorageHttpBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> StorageHttpBuilder<S, St>
where
    St: storage_http_state::State,
    St::Shards: storage_http_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> StorageHttp<S> {
        StorageHttp {
            shards: self._fields.0.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>>) -> StorageHttp<S> {
        StorageHttp {
            shards: self._fields.0.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_science_alt_dataset_storageHttp() -> 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("science.alt.dataset.storageHttp"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "HTTP/HTTPS storage for WebDataset tar archives. Each shard is listed individually with a checksum for integrity verification. Consumers build brace-expansion patterns on the fly when needed.",
                        ),
                    ),
                    required: Some(vec![SmolStr::new_static("shards")]),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("shards"),
                            LexObjectProperty::Array(LexArray {
                                description: Some(
                                    CowStr::new_static(
                                        "Array of shard entries with URL and integrity checksum",
                                    ),
                                ),
                                items: LexArrayItem::Ref(LexRef {
                                    r#ref: CowStr::new_static("#shardEntry"),
                                    ..Default::default()
                                }),
                                min_length: Some(1usize),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map.insert(
                SmolStr::new_static("shardEntry"),
                LexUserType::Object(LexObject {
                    description: Some(CowStr::new_static(
                        "A single HTTP-accessible shard with integrity checksum",
                    )),
                    required: Some(vec![
                        SmolStr::new_static("url"),
                        SmolStr::new_static("checksum"),
                    ]),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("checksum"),
                            LexObjectProperty::Ref(LexRef {
                                r#ref: CowStr::new_static(
                                    "science.alt.dataset.entry#shardChecksum",
                                ),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("url"),
                            LexObjectProperty::String(LexString {
                                description: Some(CowStr::new_static(
                                    "HTTP/HTTPS URL for this WebDataset tar shard",
                                )),
                                format: Some(LexStringFormat::Uri),
                                max_length: Some(2000usize),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}

pub mod shard_entry_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 Checksum;
        type Url;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type Checksum = Unset;
        type Url = Unset;
    }
    ///State transition - sets the `checksum` field to Set
    pub struct SetChecksum<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetChecksum<St> {}
    impl<St: State> State for SetChecksum<St> {
        type Checksum = Set<members::checksum>;
        type Url = St::Url;
    }
    ///State transition - sets the `url` field to Set
    pub struct SetUrl<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetUrl<St> {}
    impl<St: State> State for SetUrl<St> {
        type Checksum = St::Checksum;
        type Url = Set<members::url>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `checksum` field
        pub struct checksum(());
        ///Marker type for the `url` field
        pub struct url(());
    }
}

/// Builder for constructing an instance of this type.
pub struct ShardEntryBuilder<S: BosStr, St: shard_entry_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<ShardChecksum<S>>, Option<UriValue<S>>),
    _type: PhantomData<fn() -> S>,
}

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

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

impl<S: BosStr, St> ShardEntryBuilder<S, St>
where
    St: shard_entry_state::State,
    St::Checksum: shard_entry_state::IsUnset,
{
    /// Set the `checksum` field (required)
    pub fn checksum(
        mut self,
        value: impl Into<ShardChecksum<S>>,
    ) -> ShardEntryBuilder<S, shard_entry_state::SetChecksum<St>> {
        self._fields.0 = Option::Some(value.into());
        ShardEntryBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ShardEntryBuilder<S, St>
where
    St: shard_entry_state::State,
    St::Url: shard_entry_state::IsUnset,
{
    /// Set the `url` field (required)
    pub fn url(
        mut self,
        value: impl Into<UriValue<S>>,
    ) -> ShardEntryBuilder<S, shard_entry_state::SetUrl<St>> {
        self._fields.1 = Option::Some(value.into());
        ShardEntryBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> ShardEntryBuilder<S, St>
where
    St: shard_entry_state::State,
    St::Checksum: shard_entry_state::IsSet,
    St::Url: shard_entry_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> ShardEntry<S> {
        ShardEntry {
            checksum: self._fields.0.unwrap(),
            url: 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>>) -> ShardEntry<S> {
        ShardEntry {
            checksum: self._fields.0.unwrap(),
            url: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}