json-ld 0.22.0

JSON-LD implementation
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

use rdf_syntax::{Iri, IriBuf, iri};

pub const PROFILE_EXPANDED_IRI: &Iri = iri!("http://www.w3.org/ns/json-ld#expanded");
pub const PROFILE_COMPACTED_IRI: &Iri = iri!("http://www.w3.org/ns/json-ld#compacted");
pub const PROFILE_CONTEXT_IRI: &Iri = iri!("http://www.w3.org/ns/json-ld#context");
pub const PROFILE_FLATTENED_IRI: &Iri = iri!("http://www.w3.org/ns/json-ld#flattened");
pub const PROFILE_FRAMED_IRI: &Iri = iri!("http://www.w3.org/ns/json-ld#framed");

/// Standard `profile` parameter values defined for the `application/ld+json`.
///
/// See: <https://www.w3.org/TR/json-ld11/#iana-considerations>
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum JsonLdStandardProfile {
	/// To request or specify expanded JSON-LD document form.
	Expanded,

	/// To request or specify compacted JSON-LD document form.
	Compacted,

	/// To request or specify a JSON-LD context document.
	Context,

	/// To request or specify flattened JSON-LD document form.
	Flattened,

	// /// To request or specify a JSON-LD frame document.
	// Frame,
	/// To request or specify a JSON-LD framed document.
	Framed,
}

impl JsonLdStandardProfile {
	pub fn from_iri(iri: &Iri) -> Option<Self> {
		if iri == PROFILE_EXPANDED_IRI {
			Some(Self::Expanded)
		} else if iri == PROFILE_COMPACTED_IRI {
			Some(Self::Compacted)
		} else if iri == PROFILE_CONTEXT_IRI {
			Some(Self::Context)
		} else if iri == PROFILE_FLATTENED_IRI {
			Some(Self::Flattened)
		} else if iri == PROFILE_FRAMED_IRI {
			Some(Self::Framed)
		} else {
			None
		}
	}

	pub fn iri(&self) -> &'static Iri {
		match self {
			Self::Expanded => PROFILE_CONTEXT_IRI,
			Self::Compacted => PROFILE_COMPACTED_IRI,
			Self::Context => PROFILE_CONTEXT_IRI,
			Self::Flattened => PROFILE_FLATTENED_IRI,
			Self::Framed => PROFILE_FRAMED_IRI,
		}
	}
}

/// Value for the `profile` parameter defined for the `application/ld+json`.
///
/// Standard values defined by the JSON-LD specification are defined by the
/// [`JsonLdStandardProfile`] type.
///
/// See: <https://www.w3.org/TR/json-ld11/#iana-considerations>
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct JsonLdProfile(Inner);

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
enum Inner {
	Standard(JsonLdStandardProfile),
	Custom(IriBuf),
}

impl JsonLdProfile {
	pub const EXPANDED: Self = Self(Inner::Standard(JsonLdStandardProfile::Expanded));
	pub const COMPACTED: Self = Self(Inner::Standard(JsonLdStandardProfile::Compacted));
	pub const CONTEXT: Self = Self(Inner::Standard(JsonLdStandardProfile::Context));
	pub const FLATTENED: Self = Self(Inner::Standard(JsonLdStandardProfile::Flattened));
	pub const FRAMED: Self = Self(Inner::Standard(JsonLdStandardProfile::Framed));

	pub fn new(iri: &Iri) -> Self {
		match JsonLdStandardProfile::from_iri(iri) {
			Some(p) => Self(Inner::Standard(p)),
			None => Self(Inner::Custom(iri.to_owned())),
		}
	}

	pub fn iri(&self) -> &Iri {
		match &self.0 {
			Inner::Standard(s) => s.iri(),
			Inner::Custom(c) => c,
		}
	}

	pub fn as_standard(&self) -> Option<JsonLdStandardProfile> {
		match &self.0 {
			Inner::Standard(s) => Some(*s),
			Inner::Custom(_) => None,
		}
	}

	pub fn into_standard(self) -> Result<JsonLdStandardProfile, IriBuf> {
		match self.0 {
			Inner::Standard(s) => Ok(s),
			Inner::Custom(e) => Err(e),
		}
	}
}