Enum 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: VocabularyMut<Iri = T, BlankId = B>, G: LocalGenerator>( &mut self, vocabulary: &mut V, generator: &mut G, ) -> Result<(), GeneratedIdError>

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

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

Errors

Returns an error when the generator runs out of identifiers.

pub fn identify_all<G: LocalGenerator>( &mut self, generator: &mut G, ) -> Result<(), GeneratedIdError>

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.

Errors

Returns an error when the generator runs out of identifiers.

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

Puts every literal of the object into canonical form, using the given buffer to render numbers.

pub fn canonicalize(&mut self)

Puts every literal of the object 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 into 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>,

Returns the object as a string.

If the object is a value holding a string, returns that string. If the object is a node with an identifier, returns the identifier as a string. Returns None otherwise.

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

Returns the object as a boolean, if it is a value holding one.

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

Returns the object as a number, if it is a value holding one.

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

Returns the associated language, if the object is a language-tagged value.

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 differs from equality for anonymous objects: list objects and anonymous node objects stand for implicit, unlabeled blank nodes, so they are never equivalent to anything.

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

Returns an iterator over the entries of the 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,

Rewrites every IRI and identifier of the object (recursively) with the given functions.

Trait Implementations

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

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

Borrows the object as a value, node or list reference.

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

Returns the identifier (@id) of the object, if it is a node object with one.

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

where T: 'a, B: 'a,

Returns the language tag of this value, if it carries one.

fn is_value(&self) -> bool

Checks whether the object is a value object.

fn is_node(&self) -> bool

Checks whether the object is a node object.

fn is_graph(&self) -> bool

Checks whether the object is a graph object (a node object with a @graph entry).

fn is_list(&self) -> bool

Checks whether the object is a list object.

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

fn clone(&self) -> Self

Returns a duplicate 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: Eq + Hash, B: Eq + Hash> Eq for Object<T, B>

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

Converts this value into JSON, resolving the identifiers it holds against the given vocabulary.

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

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

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

where S: Visitor<I>,

Visit the RDF dataset represented by this type.

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

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

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

where S: GraphVisitor<I>,

Visits the subjects of the graph represented by this value.

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

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

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

where S: PredicateObjectsVisitor<I>,

Visits the objects this predicate points at.

impl<T, B, I: Interpretation> LinkedDataResource<I> for Object<T, B>

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

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

Returns the interpretation of this resource, inserting it into interpretation if required.

fn lexical_representation<'a>( &'a self, interpretation: &'a mut I, ) -> Option<CowRdfTerm<'a>>

where I: ReverseInterpretation + ReverseLocalInterpretation,

Returns the lexical term representing this resource, if any.

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

Returns the interpretation to use when this resource appears as a reference rather than as a subject with properties.

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

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

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

where S: SubjectVisitor<I>,

Visits the properties of the subject represented by this value.

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

type BlankId = B

Blank node identifier type the renaming applies to.

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

Equality operator ==.

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

Inequality operator !=.

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

fn relabel_with<N: VocabularyMut<Iri = T, BlankId = B>, G: LocalGenerator>( &mut self, vocabulary: &mut N, generator: &mut G, relabeling: &mut HashMap<B, ValidId<T, B>>, ) -> Result<(), GeneratedIdError>

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

Relabels every blank node, recording the mapping so shared nodes keep the same new identifier.

fn relabel<G: LocalGenerator>( &mut self, generator: &mut G, relabeling: &mut HashMap<B, ValidId<T, B>>, ) -> Result<(), GeneratedIdError>

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

Relabels every blank node, recording the mapping.

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>

Builds this fragment from a JSON value, interning terms in the given vocabulary.

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>

Builds this fragment from a JSON object, interning terms in the given vocabulary.