axiolid-contracts 0.2.0

Common backend-neutral execution and diagnostic contracts
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

//! Stable, transport-independent capability identifiers.

use core::fmt;

/// Versioned semantic operation identity, independent of providers and wire encoding.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CapabilityId(&'static str);

impl CapabilityId {
    pub const fn from_static(value: &'static str) -> Self {
        Self(value)
    }
    pub const fn as_str(self) -> &'static str {
        self.0
    }
}

impl fmt::Debug for CapabilityId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("CapabilityId").field(&self.0).finish()
    }
}
impl fmt::Display for CapabilityId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.0)
    }
}

pub mod capability_ids {
    use super::CapabilityId;
    pub const TESSELLATE: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.tessellate.v1");
    pub const MESH_BOOLEAN: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.mesh-boolean.v1");
    pub const MESH_SECTION: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.mesh-section.v1");
    /// Point-sampled geometry reconstructed into a discrete surface.
    ///
    /// Distinct from [`MESH_BOOLEAN`] and friends because the input is not a
    /// mesh at all: a provider advertising this claims it can turn an
    /// unstructured point set into a surface, which is a different
    /// obligation from operating on one that already exists.
    pub const POINTCLOUD_RECONSTRUCTION: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.pointcloud-reconstruction.v1");
    pub const MESH_VALIDATE: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.mesh-validate.v1");
    pub const MESH_MEASURE: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.mesh-measure.v1");
    pub const RAY_MESH: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.ray-mesh.v1");
    pub const EXACT_EXTRUDE: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.exact-extrude.v1");
    pub const GRAPH_TO_MESH: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.graph-to-mesh.v1");
    /// Graph lowered to an exact B-rep, or refused.
    ///
    /// Deliberately distinct from [`GRAPH_TO_MESH`]: a backend advertising this
    /// promises analytic supports and trims survive, never triangles.
    pub const GRAPH_TO_EXACT_BREP: CapabilityId =
        CapabilityId::from_static("org.axiolid.geometry.graph-to-exact-brep.v1");
    pub const ALL: [CapabilityId; 9] = [
        TESSELLATE,
        MESH_BOOLEAN,
        MESH_SECTION,
        MESH_VALIDATE,
        MESH_MEASURE,
        RAY_MESH,
        EXACT_EXTRUDE,
        GRAPH_TO_MESH,
        GRAPH_TO_EXACT_BREP,
    ];
}

#[cfg(test)]
mod tests {
    use super::capability_ids::ALL;
    use std::collections::BTreeSet;

    #[test]
    fn ids_are_unique_versioned_ascii_tokens() {
        let unique: BTreeSet<_> = ALL.iter().map(|id| id.as_str()).collect();
        assert_eq!(unique.len(), ALL.len());
        for id in ALL {
            let text = id.as_str();
            assert!(text.ends_with(".v1"));
            assert!(text
                .bytes()
                .all(|b| b.is_ascii_lowercase() || b.is_ascii_digit() || matches!(b, b'.' | b'-')));
        }
    }
}