+ 
+
+# Data Privacy Core
+
+[](https://crates.io/crates/data_privacy_core)
+[](https://docs.rs/data_privacy_core)
+[](https://crates.io/crates/data_privacy_core)
+[](https://github.com/microsoft/oxidizer/actions/workflows/main.yml)
+[](https://codecov.io/gh/microsoft/oxidizer)
+[](../../LICENSE)
+
+
+
+
+Core data classification types and traits.
+
+The `data_privacy_core` crate contains the trait definitions and the [`DataClass`][__link0] type
+with no support for `#[derive()]` or attribute macros.
+
+In crates that use `#[taxonomy]`, `#[classified]`, `#[derive(RedactedDebug)]`, or
+`#[derive(RedactedDisplay)]`, you must depend on the **[`data_privacy`][__link1]**
+crate, not `data_privacy_core`.
+
+In crates that hand-write implementations of data privacy traits, or only use them as trait
+bounds, depending on `data_privacy_core` is permitted. But `data_privacy` re-exports all of
+these traits and can be used for this use case too. **If in doubt, disregard `data_privacy_core`
+and always use `data_privacy`.**
+
+## Contents
+
+* [`DataClass`][__link2] - identifies a data class within a taxonomy
+* [`Classified`][__link3] - trait for types that hold classified data
+* [`Redactor`][__link4] - trait for types that can apply redaction
+* [`RedactedDebug`][__link5] / [`RedactedDisplay`][__link6] / [`RedactedToString`][__link7] - redaction-aware formatting traits
+
+
+
+
+# Data Privacy Core
+
+[](https://crates.io/crates/data_privacy_core)
+[](https://docs.rs/data_privacy_core)
+[](https://crates.io/crates/data_privacy_core)
+[](https://github.com/microsoft/oxidizer/actions/workflows/main.yml)
+[](https://codecov.io/gh/microsoft/oxidizer)
+[](../../LICENSE)
+
+
++ +This crate was developed as part of The Oxidizer Project. Browse this crate's source code. + + + [__cargo_doc2readme_dependencies_info]: ggGmYW0CYXZlMC43LjJhdIQbLiTyV0MU86EbZU15e0PmecoboQ9jo59bnAEbyDXw04U13GlhYvRhcoQbJMSGY2z7YbEblsBSe-58K48b62Bomn7PG1Ebw8HBurz5KcZhZIGCcWRhdGFfcHJpdmFjeV9jb3JlZTAuMS4w + [__link0]: https://docs.rs/data_privacy_core/0.1.0/data_privacy_core/?search=DataClass + [__link1]: https://docs.rs/data_privacy + [__link2]: https://docs.rs/data_privacy_core/0.1.0/data_privacy_core/?search=DataClass + [__link3]: https://docs.rs/data_privacy_core/0.1.0/data_privacy_core/?search=Classified + [__link4]: https://docs.rs/data_privacy_core/0.1.0/data_privacy_core/?search=Redactor + [__link5]: https://docs.rs/data_privacy_core/0.1.0/data_privacy_core/?search=RedactedDebug + [__link6]: https://docs.rs/data_privacy_core/0.1.0/data_privacy_core/?search=RedactedDisplay + [__link7]: https://docs.rs/data_privacy_core/0.1.0/data_privacy_core/?search=RedactedToString diff --git a/crates/data_privacy/src/classified.rs b/crates/data_privacy_core/src/classified.rs similarity index 85% rename from crates/data_privacy/src/classified.rs rename to crates/data_privacy_core/src/classified.rs index ca7c2383c..648326d1b 100644 --- a/crates/data_privacy/src/classified.rs +++ b/crates/data_privacy_core/src/classified.rs @@ -10,8 +10,9 @@ use crate::DataClass; /// Although instances are encapsulated, it's possible to extract the instances when /// classification is no longer needed. /// -/// You rarely implement this trait by hand, instead use the [`classified`](data_privacy_macros::classified) macro to generate -/// classified types automatically. +/// You rarely implement this trait by hand, instead use the +/// [`classified`](https://docs.rs/data_privacy/latest/data_privacy/attr.classified.html) macro from the +/// [`data_privacy`](https://docs.rs/data_privacy) crate to generate classified types automatically. /// /// # Ancillary Traits /// @@ -26,7 +27,7 @@ use crate::DataClass; /// # Example /// /// ```rust -/// use data_privacy::{Classified, DataClass}; +/// use data_privacy_core::{Classified, DataClass}; /// /// #[derive(Debug)] /// struct Person { @@ -63,7 +64,6 @@ use crate::DataClass; /// assert_eq!(classified.data_class().name(), "classified_person"); /// ``` pub trait Classified { - /// Returns the data class of the classified data. - #[must_use] + /// Returns the data class assigned to this instance. fn data_class(&self) -> &DataClass; } diff --git a/crates/data_privacy/src/data_class.rs b/crates/data_privacy_core/src/data_class.rs similarity index 72% rename from crates/data_privacy/src/data_class.rs rename to crates/data_privacy_core/src/data_class.rs index f0df83749..db9c6e9ce 100644 --- a/crates/data_privacy/src/data_class.rs +++ b/crates/data_privacy_core/src/data_class.rs @@ -145,12 +145,10 @@ const fn is_valid_identifier(s: &str) -> bool { return false; } - // Validate first character if !is_valid_ascii_ident_start(bytes[0]) { return false; } - // Validate remaining characters let mut i = 1; while i < bytes.len() { if !is_valid_ascii_ident_continue(bytes[i]) { @@ -162,141 +160,138 @@ const fn is_valid_identifier(s: &str) -> bool { true } -#[cfg(all(test, feature = "serde"))] +#[cfg(test)] +#[cfg_attr(coverage_nightly, coverage(off))] mod tests { use super::*; #[test] - fn test_serialize() { - let dc = DataClass::new("contoso", "customer_identifier"); - let serialized = serde_json::to_string(&dc).expect("failed to serialize"); - assert_eq!(serialized, "\"contoso/customer_identifier\""); - } - - #[test] - fn test_deserialize_valid() { - let serialized = "\"contoso/customer_identifier\""; - let dc: DataClass = serde_json::from_str(serialized).expect("failed to deserialize"); + fn new_stores_taxonomy_and_name() { + let dc = DataClass::new("contoso", "customer_id"); assert_eq!(dc.taxonomy(), "contoso"); - assert_eq!(dc.name(), "customer_identifier"); + assert_eq!(dc.name(), "customer_id"); } #[test] - fn test_deserialize_invalid_format_no_slash() { - let serialized = "\"contoso_customer_identifier\""; - let err = serde_json::from_str::