dag-ml-data-core 0.2.0

Core data contracts, schemas and plans for dag-ml-data.
Documentation
use std::fmt;

use serde::{Deserialize, Serialize};

use crate::error::{DataError, Result};

fn validate_identifier(value: &str) -> Result<()> {
    if value.is_empty() {
        return Err(DataError::InvalidIdentifier {
            value: value.to_string(),
            reason: "identifier is empty",
        });
    }
    if value.len() > 128 {
        return Err(DataError::InvalidIdentifier {
            value: value.to_string(),
            reason: "identifier is longer than 128 bytes",
        });
    }
    if !value
        .bytes()
        .all(|b| b.is_ascii_alphanumeric() || matches!(b, b'_' | b'-' | b'.'))
    {
        return Err(DataError::InvalidIdentifier {
            value: value.to_string(),
            reason: "identifier contains unsupported characters",
        });
    }
    Ok(())
}

macro_rules! define_id {
    ($name:ident) => {
        #[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
        #[serde(try_from = "String", into = "String")]
        pub struct $name(String);

        impl $name {
            pub fn new(value: impl Into<String>) -> Result<Self> {
                let value = value.into();
                validate_identifier(&value)?;
                Ok(Self(value))
            }

            pub fn as_str(&self) -> &str {
                &self.0
            }
        }

        impl TryFrom<String> for $name {
            type Error = DataError;

            fn try_from(value: String) -> Result<Self> {
                Self::new(value)
            }
        }

        impl From<$name> for String {
            fn from(value: $name) -> Self {
                value.0
            }
        }

        impl fmt::Display for $name {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                self.0.fmt(f)
            }
        }
    };
}

define_id!(SampleId);
define_id!(SourceId);
define_id!(RepresentationId);
define_id!(TypeId);
define_id!(ObservationId);
define_id!(TargetId);
define_id!(GroupId);
define_id!(OriginId);
define_id!(RepetitionId);

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn accepts_data_ids() {
        assert!(SourceId::new("nir.source_1").is_ok());
    }

    #[test]
    fn rejects_graph_style_colon_for_data_ids() {
        assert!(SourceId::new("source:nir").is_err());
    }
}