Enum json_ld_core::object::Object

pub enum Object<T = IriBuf, B = BlankIdBuf> {
    Value(Value<T>),
    Node(Box<Node<T, B>>),
    List(List<T, B>),
}

Object.

JSON-LD connects together multiple kinds of data objects. Objects may be nodes, values or lists of objects.

You can get an Object by expanding a JSON-LD document using the expansion algorithm or by converting an already expanded JSON document using TryFromJson.

Variants

Value(Value<T>)

Value object.

Node(Box<Node<T, B>>)

Node object.

List(List<T, B>)

List object.

Implementations

impl<T, B> Object<T, B>

pub fn null() -> Self

Creates a null value object.

pub fn node(n: Node<T, B>) -> Self

Creates a new node object from a node.

pub fn id(&self) -> Option<&Id<T, B>>

Identifier of the object, if it is a node object.

pub fn identify_all_with<V: Vocabulary<Iri = T, BlankId = B>, G: Generator<V>>( &mut self, vocabulary: &mut V, generator: &mut G, )

where T: Eq + Hash, B: Eq + Hash,

Assigns an identifier to every node included in this object using the given generator.

pub fn identify_all<G: Generator>(&mut self, generator: &mut G)

where T: Eq + Hash, B: Eq + Hash, (): Vocabulary<Iri = T, BlankId = B>,

Use the given generator to assign an identifier to all nodes that don’t have one.

pub fn canonicalize_with(&mut self, buffer: &mut Buffer)

Puts this object literals into canonical form using the given buffer.

The buffer is used to compute the canonical form of numbers.

pub fn canonicalize(&mut self)

Puts this object literals into canonical form.

pub fn types(&self) -> Types<'_, T, B>

Returns an iterator over the types of the object.

pub fn as_iri(&self) -> Option<&T>

Identifier of the object as an IRI.

If the object is a node identified by an IRI, returns this IRI. Returns None otherwise.

pub fn is_value(&self) -> bool

Tests if the object is a value.

pub fn as_value(&self) -> Option<&Value<T>>

Returns this object as a value, if it is one.

pub fn as_value_mut(&mut self) -> Option<&mut Value<T>>

Returns this object as a mutable value, if it is one.

pub fn into_value(self) -> Option<Value<T>>

Converts this object as a value, if it is one.

pub fn is_node(&self) -> bool

Tests if the object is a node.

pub fn as_node(&self) -> Option<&Node<T, B>>

Returns this object as a node, if it is one.

pub fn as_node_mut(&mut self) -> Option<&mut Node<T, B>>

Returns this object as a mutable node, if it is one.

pub fn into_node(self) -> Option<Node<T, B>>

Converts this object into a node, if it is one.

pub fn is_graph(&self) -> bool

Tests if the object is a graph object (a node with a @graph field).

pub fn is_list(&self) -> bool

Tests if the object is a list.

pub fn as_list(&self) -> Option<&List<T, B>>

Returns this object as a list, if it is one.

pub fn as_list_mut(&mut self) -> Option<&mut List<T, B>>

Returns this object as a mutable list, if it is one.

pub fn into_list(self) -> Option<List<T, B>>

Converts this object into a list, if it is one.

pub fn as_str(&self) -> Option<&str>

where T: AsRef<str>, B: AsRef<str>,

Get the object as a string.

If the object is a value that is a string, returns this string. If the object is a node that is identified, returns the identifier as a string. Returns None otherwise.

pub fn as_bool(&self) -> Option<bool>

Get the value as a boolean, if it is.

pub fn as_number(&self) -> Option<&Number>

Get the value as a number, if it is.

pub fn language(&self) -> Option<&LenientLangTag>

If the object is a language-tagged value, Return its associated language.

pub fn traverse(&self) -> Traverse<'_, T, B>

Returns an iterator over all fragments of this object, including the object itself.

Fragments include:

• objects
• key-value pairs,
• keys
• values

pub fn equivalent(&self, other: &Self) -> bool

where T: Eq + Hash, B: Eq + Hash,

Equivalence operator.

Equivalence is different from equality for anonymous objects: List objects and anonymous node objects have an implicit unlabeled blank nodes and thus never equivalent.

pub fn entries(&self) -> Entries<'_, T, B>

Returns an iterator over the entries of JSON representation of the object.

pub fn map_ids<U, C>( self, map_iri: impl FnMut(T) -> U, map_id: impl FnMut(Id<T, B>) -> Id<U, C>, ) -> Object<U, C>

where U: Eq + Hash, C: Eq + Hash,

Map the identifiers present in this object (recursively).

Trait Implementations

impl<T, B> Any<T, B> for Object<T, B>

fn as_ref(&self) -> Ref<'_, T, B>

fn id(&self) -> Option<&Id<T, B>>

fn language<'a>(&'a self) -> Option<&LenientLangTag>

where T: 'a, B: 'a,

fn is_value(&self) -> bool

fn is_node(&self) -> bool

fn is_graph(&self) -> bool

fn is_list(&self) -> bool

impl<T: Clone, B: Clone> Clone for Object<T, B>

fn clone(&self) -> Object<T, B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, B: Debug> Debug for Object<T, B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, B> From<Node<T, B>> for Object<T, B>

fn from(node: Node<T, B>) -> Self

Converts to this type from the input type.

impl<T, B> From<Value<T>> for Object<T, B>

fn from(value: Value<T>) -> Self

Converts to this type from the input type.

impl<T: Hash, B: Hash> Hash for Object<T, B>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, B, N: Vocabulary<Iri = T, BlankId = B>> IntoJsonWithContext<N> for Object<T, B>

fn into_json_with(self, vocabulary: &N) -> Value

impl<T, B, V, I: Interpretation> LinkedData<I, V> for Object<T, B>

where T: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, B: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, V: IriVocabularyMut + Vocabulary<Iri = T>,

fn visit<S>(&self, visitor: S) -> Result<S::Ok, S::Error>

where S: Visitor<I, V>,

Visit the RDF dataset represented by this type.

impl<T, B, V, I: Interpretation> LinkedDataGraph<I, V> for Object<T, B>

where T: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, B: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, V: IriVocabularyMut + Vocabulary<Iri = T>,

fn visit_graph<S>(&self, visitor: S) -> Result<S::Ok, S::Error>

where S: GraphVisitor<I, V>,

impl<T, B, V, I: Interpretation> LinkedDataPredicateObjects<I, V> for Object<T, B>

where T: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, B: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, V: IriVocabularyMut + Vocabulary<Iri = T>,

fn visit_objects<S>(&self, visitor: S) -> Result<S::Ok, S::Error>

where S: PredicateObjectsVisitor<I, V>,

impl<T, B, V: Vocabulary<Iri = T>, I: Interpretation> LinkedDataResource<I, V> for Object<T, B>

where T: LinkedDataResource<I, V>, B: LinkedDataResource<I, V>,

fn interpretation( &self, vocabulary: &mut V, interpretation: &mut I, ) -> ResourceInterpretation<'_, I, V>

fn reference_interpretation( &self, vocabulary: &mut V, interpretation: &mut I, ) -> ResourceInterpretation<'_, I, V>

impl<T, B, V, I: Interpretation> LinkedDataSubject<I, V> for Object<T, B>

where T: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, B: LinkedDataResource<I, V> + LinkedDataSubject<I, V>, V: IriVocabularyMut + Vocabulary<Iri = T>,

fn visit_subject<S>(&self, visitor: S) -> Result<S::Ok, S::Error>

where S: SubjectVisitor<I, V>,

impl<T: Eq + Hash, B: Eq + Hash> MappedEq for Object<T, B>

type BlankId = B

fn mapped_eq<'a, 'b, F: Clone + Fn(&'a B) -> &'b B>( &'a self, other: &Self, f: F, ) -> bool

where B: 'a + 'b,

Structural equality with mapped blank identifiers.

impl<T, B> PartialEq for Object<T, B>

where T: Eq + Hash, B: Eq + Hash,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, B> Relabel<T, B> for Object<T, B>

fn relabel_with<N: Vocabulary<Iri = T, BlankId = B>, G: Generator<N>>( &mut self, vocabulary: &mut N, generator: &mut G, relabeling: &mut HashMap<B, Subject<T, B>>, )

where T: Clone + Eq + Hash, B: Clone + Eq + Hash,

impl<T, B> TryFrom<Object<T, B>> for Node<T, B>

type Error = Object<T, B>

The type returned in the event of a conversion error.

fn try_from(obj: Object<T, B>) -> Result<Node<T, B>, Object<T, B>>

Performs the conversion.

impl<T: Eq + Hash, B: Eq + Hash> TryFromJson<T, B> for Object<T, B>

fn try_from_json_in( vocabulary: &mut impl VocabularyMut<Iri = T, BlankId = B>, value: Value, ) -> Result<Self, InvalidExpandedJson>

impl<T: Eq + Hash, B: Eq + Hash> TryFromJsonObject<T, B> for Object<T, B>

fn try_from_json_object_in( vocabulary: &mut impl VocabularyMut<Iri = T, BlankId = B>, object: Object, ) -> Result<Self, InvalidExpandedJson>

impl<T, B> Eq for Object<T, B>

where T: Eq + Hash, B: Eq + Hash,