homestar-invocation 0.3.0

Homestar core library for working with tasks, instructions, etc
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! JSON Schema generation for DAG-JSON encoded Ipld.

use const_format::formatcp;
use schemars::{
    gen::SchemaGenerator,
    schema::{InstanceType, Metadata, ObjectValidation, Schema, SchemaObject, SingleOrVec},
    JsonSchema,
};
use std::{borrow::Cow, collections::BTreeMap, module_path};

/// Ipld stub for JSON Schema generation
#[derive(Debug)]
#[doc(hidden)]
pub struct IpldStub();

// The Ipld stub exists solely to implement a JSON Schema
// represenation of Ipld. Should libipld provide an implementation
// in the future, this can be removed.
impl JsonSchema for IpldStub {
    fn schema_name() -> String {
        "ipld".to_owned()
    }

    fn schema_id() -> Cow<'static, str> {
        Cow::Borrowed(formatcp!("{}::IpldStub", module_path!()))
    }

    fn json_schema(gen: &mut SchemaGenerator) -> Schema {
        let mut schema = SchemaObject {
            instance_type: None,
            metadata: Some(Box::new(Metadata {
                title: Some("Ipld".to_string()),
                description: Some("DAG-JSON encoded IPLD: https://github.com/ipld/ipld/blob/master/specs/codecs/dag-json/spec.md".to_string()),
                ..Default::default()
            })),
            ..Default::default()
        };

        let number_schema = SchemaObject {
            instance_type: Some(SingleOrVec::Single(InstanceType::Number.into())),
            ..Default::default()
        };
        let array_schema = SchemaObject {
            instance_type: Some(SingleOrVec::Single(InstanceType::Array.into())),
            ..Default::default()
        };
        let object_schema = SchemaObject {
            instance_type: Some(SingleOrVec::Single(InstanceType::Object.into())),
            ..Default::default()
        };

        schema.subschemas().one_of = Some(vec![
            <()>::json_schema(gen),
            <bool>::json_schema(gen),
            Schema::Object(number_schema),
            <String>::json_schema(gen),
            gen.subschema_for::<IpldBytesStub>(),
            Schema::Object(array_schema),
            Schema::Object(object_schema),
            gen.subschema_for::<IpldLinkStub>(),
        ]);

        schema.into()
    }
}

/// Ipld link stub for JSON Schema generation
#[derive(Debug)]
#[doc(hidden)]
pub struct IpldLinkStub();

impl JsonSchema for IpldLinkStub {
    fn schema_name() -> String {
        "ipld_link".to_owned()
    }

    fn schema_id() -> Cow<'static, str> {
        Cow::Borrowed(formatcp!("{}::IpldLinkStub", module_path!()))
    }

    fn json_schema(gen: &mut SchemaGenerator) -> Schema {
        let schema = SchemaObject {
            instance_type: Some(SingleOrVec::Single(InstanceType::Object.into())),
            object: Some(Box::new(ObjectValidation {
                properties: BTreeMap::from([('/'.to_string(), <String>::json_schema(gen))]),
                ..Default::default()
            })),
            metadata: Some(Box::new(Metadata {
                title: Some("IPLD link".to_string()),
                description: Some("CID link that points to some IPLD data".to_string()),
                ..Default::default()
            })),
            ..Default::default()
        };

        schema.into()
    }
}

/// Ipld bytes stub for JSON Schema generation
#[derive(Debug)]
#[doc(hidden)]
pub struct IpldBytesStub();

impl JsonSchema for IpldBytesStub {
    fn schema_name() -> String {
        "ipld_bytes".to_owned()
    }

    fn schema_id() -> Cow<'static, str> {
        Cow::Borrowed(formatcp!("{}::IpldBytesStub", module_path!()))
    }

    fn json_schema(gen: &mut SchemaGenerator) -> Schema {
        let schema = SchemaObject {
            instance_type: Some(SingleOrVec::Single(InstanceType::Object.into())),
            metadata: Some(Box::new(Metadata {
                title: Some("IPLD bytes".to_string()),
                description: Some("Base64 encoded binary".to_string()),
                ..Default::default()
            })),
            object: Some(Box::new(ObjectValidation {
                properties: BTreeMap::from([(
                    '/'.to_string(),
                    Schema::Object(SchemaObject {
                        instance_type: Some(SingleOrVec::Single(InstanceType::Object.into())),
                        object: Some(Box::new(ObjectValidation {
                            properties: BTreeMap::from([(
                                "bytes".to_string(),
                                <String>::json_schema(gen),
                            )]),
                            ..Default::default()
                        })),
                        ..Default::default()
                    }),
                )]),
                ..Default::default()
            })),
            ..Default::default()
        };

        schema.into()
    }
}