Struct Indexed 

pub struct Indexed<T> { /* private fields */ }

Indexed objects.

Nodes and value objects may be indexed by a string in JSON-LD. This type is a wrapper around any kind of indexable data.

It is a pointer type that Deref into the underlying value.

Implementations

impl<T> Indexed<T>

pub fn none(value: T) -> Self

Creates a non-indexed value, without metadata.

pub fn new(value: T, index: Option<String>) -> Self

Create a new (maybe) indexed value.

pub fn inner(&self) -> &T

Get a reference to the inner value.

pub fn inner_mut(&mut self) -> &mut T

Mutably borrows the indexed value.

pub fn into_inner(self) -> T

Drops the index and returns the underlying value.

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

Returns the @index of the value, if it has one.

pub fn set_index(&mut self, index: Option<String>)

Sets the @index of the value, or removes it when given None.

pub fn into_parts(self) -> (T, Option<String>)

Consumes the indexed value, returning the inner value and its @index.

pub fn map_inner<U, F>(self, f: F) -> Indexed<U>

where F: FnOnce(T) -> U,

Cast the inner value.

pub fn cast<U: From<T>>(self) -> Indexed<U>

Cast the inner value.

pub fn try_cast<U: TryFrom<T>>(self) -> Result<Indexed<U>, Indexed<U::Error>>

Try to cast the inner value.

Errors

Returns the index and the conversion error when the inner value does not convert.

impl<T, B> Indexed<Node<T, B>>

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

Returns an iterator over the entries of the JSON representation of the node, including its @index entry if any.

impl<T: Eq + Hash, B: Eq + Hash> Indexed<Node<T, B>>

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

Checks whether the two indexed nodes are equivalent: same @index and equivalent inner nodes.

impl<T: Eq + Hash, B: Eq + Hash> Indexed<Object<T, B>>

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

Checks whether the two indexed objects are equivalent: same @index and equivalent inner objects.

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

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

Converts this indexed object into an indexed node, if it is one.

pub fn into_indexed_value(self) -> Option<Indexed<Value<T>>>

Converts this indexed object into an indexed value, if it is one.

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

Converts this indexed object into an indexed list, if it is one.

pub fn into_unnamed_graph(self) -> Result<Graph<T, B>, Self>

Try to convert this object into an unnamed graph.

Errors

Returns self unchanged when the object is not a graph object, or is a named graph.

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

Returns an iterator over the entries of the JSON representation of the object, including its @index entry if any.

Trait Implementations

impl<T> AsMut<T> for Indexed<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for Indexed<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Indexed<T>

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> Debug for Indexed<T>

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

Formats the value using the given formatter.

impl<T> Deref for Indexed<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Indexed<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Eq> Eq for Indexed<T>

impl<T: Hash + Eq, B: Hash + Eq> Extend<Indexed<Object<T, B>>> for ExpandedDocument<T, B>

fn extend<I: IntoIterator<Item = IndexedObject<T, B>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: Eq + Hash, B: Eq + Hash> From<Indexed<Node<T, B>>> for ExpandedDocument<T, B>

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

Converts to this type from the input type.

impl<T> From<T> for Indexed<T>

fn from(value: T) -> Indexed<T>

Converts to this type from the input type.

impl<T: Hash + Eq, B: Hash + Eq> FromIterator<Indexed<Object<T, B>>> for ExpandedDocument<T, B>

fn from_iter<I: IntoIterator<Item = IndexedObject<T, B>>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash> Hash for Indexed<T>

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: IntoJsonWithContext<N>, N> IntoJsonWithContext<N> for Indexed<T>

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

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

impl<T: MappedEq> MappedEq for Indexed<T>

type BlankId = <T as MappedEq>::BlankId

Blank node identifier type the renaming applies to.

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

where Self::BlankId: 'a + 'b,

Structural equality with mapped blank identifiers.

impl<T: Ord> Ord for Indexed<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<T: PartialEq> PartialEq for Indexed<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Indexed<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

fn contextual_pre_compute_size( &self, vocabulary: &N, options: &Options, sizes: &mut Vec<Size>, ) -> Size

Computes the printed size of this value against context.

impl<T, B, N: Vocabulary<Iri = T, BlankId = B>> PrecomputeSizeWithContext<N> for Indexed<Node<T, B>>

fn contextual_pre_compute_size( &self, vocabulary: &N, options: &Options, sizes: &mut Vec<Size>, ) -> Size

Computes the printed size of this value against context.

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

fn contextual_fmt_with_size( &self, vocabulary: &N, f: &mut Formatter<'_>, options: &Options, indent: usize, sizes: &[Size], index: &mut usize, ) -> Result

Writes the value to f against context, taking its layout from sizes[*index].

impl<T, B, N: Vocabulary<Iri = T, BlankId = B>> PrintWithSizeAndContext<N> for Indexed<Node<T, B>>

fn contextual_fmt_with_size( &self, vocabulary: &N, f: &mut Formatter<'_>, options: &Options, indent: usize, sizes: &[Size], index: &mut usize, ) -> Result

Writes the value to f against context, taking its layout from sizes[*index].

impl<T: PartialEq> StructuralPartialEq for Indexed<T>

impl<T, B, O: TryFromJsonObject<T, B>> TryFromJson<T, B> for Indexed<O>

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, B, O: TryFromJsonObject<T, B>> TryFromJsonObject<T, B> for Indexed<O>

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.