jacquard-api 0.11.0

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

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::types::string::UriValue;
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::{Serialize, Deserialize};
/// (Deprecated: use storageHttp or storageS3 instead.) External storage via URLs for WebDataset tar archives. URLs support brace notation for sharding (e.g., 'data-{000000..000099}.tar').

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct StorageExternal<'a> {
    ///WebDataset URLs with optional brace notation for sharded tar files
    #[serde(borrow)]
    pub urls: Vec<UriValue<'a>>,
}

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

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

/// Builder for constructing an instance of this type
pub struct StorageExternalBuilder<'a, S: storage_external_state::State> {
    _state: PhantomData<fn() -> S>,
    _fields: (Option<Vec<UriValue<'a>>>,),
    _lifetime: PhantomData<&'a ()>,
}

impl<'a> StorageExternal<'a> {
    /// Create a new builder for this type
    pub fn new() -> StorageExternalBuilder<'a, storage_external_state::Empty> {
        StorageExternalBuilder::new()
    }
}

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

impl<'a, S> StorageExternalBuilder<'a, S>
where
    S: storage_external_state::State,
    S::Urls: storage_external_state::IsUnset,
{
    /// Set the `urls` field (required)
    pub fn urls(
        mut self,
        value: impl Into<Vec<UriValue<'a>>>,
    ) -> StorageExternalBuilder<'a, storage_external_state::SetUrls<S>> {
        self._fields.0 = Option::Some(value.into());
        StorageExternalBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _lifetime: PhantomData,
        }
    }
}

impl<'a, S> StorageExternalBuilder<'a, S>
where
    S: storage_external_state::State,
    S::Urls: storage_external_state::IsSet,
{
    /// Build the final struct
    pub fn build(self) -> StorageExternal<'a> {
        StorageExternal {
            urls: 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<
            jacquard_common::deps::smol_str::SmolStr,
            jacquard_common::types::value::Data<'a>,
        >,
    ) -> StorageExternal<'a> {
        StorageExternal {
            urls: self._fields.0.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_science_alt_dataset_storageExternal() -> LexiconDoc<'static> {
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    use alloc::collections::BTreeMap;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("science.alt.dataset.storageExternal"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::Object(LexObject {
                    description: Some(
                        CowStr::new_static(
                            "(Deprecated: use storageHttp or storageS3 instead.) External storage via URLs for WebDataset tar archives. URLs support brace notation for sharding (e.g., 'data-{000000..000099}.tar').",
                        ),
                    ),
                    required: Some(vec![SmolStr::new_static("urls")]),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("urls"),
                            LexObjectProperty::Array(LexArray {
                                description: Some(
                                    CowStr::new_static(
                                        "WebDataset URLs with optional brace notation for sharded tar files",
                                    ),
                                ),
                                items: LexArrayItem::String(LexString {
                                    format: Some(LexStringFormat::Uri),
                                    max_length: Some(1000usize),
                                    ..Default::default()
                                }),
                                min_length: Some(1usize),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}