golem-schema 1.6.1

Golem schema and value model
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

// Copyright 2024-2026 Golem Cloud
//
// Licensed under the Golem Source License v1.1 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://license.golem.cloud/LICENSE
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Schema representation, canonical encoding, and validation.
//!
//! `regex` enables the Rust `regex` crate's complete existing dialect for text
//! restrictions and union discriminators. `url` enables WHATWG URL validation
//! (including IDNA) and conversions for `url::Url`. `rich-validation` enables
//! both; it is included by default and by `host` and `full`.
//!
//! With default features disabled, the schema representation and fixed MIME,
//! quantity-unit, and tool-identifier grammars remain available. Validation
//! requiring a disabled feature returns an explicit unsupported-feature error;
//! it never accepts a value by skipping its regex or URL restriction. Regex
//! union rendering also fails explicitly. Enable the needed features in guests
//! that validate these rich values. URL schema structure and canonical encoding
//! do not require URL parsing; value validation does.

#[cfg(all(feature = "host", feature = "guest"))]
compile_error!("golem-schema features `host` and `guest` are mutually exclusive");

// Allows the `IntoSchema` / `FromSchema` derive macros to be used on types
// defined inside this crate when proc-macro-crate resolves this package as a
// regular crate name.
extern crate self as golem_schema;

#[cfg(test)]
test_r::enable!();

pub mod http;
pub mod model;
pub mod schema;

/// Protobuf messages of the schema and tool model, generated from this crate's `proto` directory.
#[cfg(feature = "protobuf")]
#[allow(clippy::large_enum_variant)]
pub mod proto {
    use uuid::Uuid;

    include!(concat!(env!("OUT_DIR"), "/mod.rs"));

    impl From<Uuid> for golem::common::Uuid {
        fn from(value: Uuid) -> Self {
            let (high_bits, low_bits) = value.as_u64_pair();
            golem::common::Uuid {
                high_bits,
                low_bits,
            }
        }
    }

    impl From<golem::common::Uuid> for Uuid {
        fn from(value: golem::common::Uuid) -> Self {
            let high_bits = value.high_bits;
            let low_bits = value.low_bits;
            Uuid::from_u64_pair(high_bits, low_bits)
        }
    }
}

pub use model::*;
pub use schema::*;