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) -> Indexed<T>

Creates a non-indexed value, without metadata.

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

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

pub fn into_inner(self) -> T

Drop the index and return the underlying value.

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

Get the index, if any.

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

Set the value index.

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

Turn this indexed value into its components: inner value and 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>(self) -> Indexed<U>

where U: From<T>,

Cast the inner value.

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

where U: TryFrom<T>,

Try to cast the inner value.

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

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

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

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

pub fn equivalent(&self, other: &Indexed<Node<T, B>>) -> bool

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

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

pub fn equivalent(&self, other: &Indexed<Object<T, B>>) -> bool

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 node, 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<IndexSet<Indexed<Object<T, B>>>, Indexed<Object<T, B>>>

Try to convert this object into an unnamed graph.

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

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

where T: Clone,

fn clone(&self) -> Indexed<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I, B, T> CompactFragment<I, B> for Indexed<T>

where T: CompactIndexedFragment<I, B>,

async fn compact_fragment_full<'a, N, L>( &'a self, vocabulary: &'a mut N, active_context: &'a Context<I, B>, type_scoped_context: &'a Context<I, B>, active_property: Option<&'a str>, loader: &'a L, options: Options, ) -> Result<Value, Error>

where N: VocabularyMut<Iri = I, BlankId = B>, I: Clone + Hash + Eq, B: Clone + Hash + Eq, L: Loader,

async fn compact_fragment_with<'a, N, L>( &'a self, vocabulary: &'a mut N, active_context: &'a Context<I, B>, loader: &'a mut L, ) -> Result<Value, Error>

where N: VocabularyMut<Iri = I, BlankId = B>, I: Clone + Hash + Eq, B: Clone + Hash + Eq, L: Loader,

async fn compact_fragment<'a, L>( &'a self, active_context: &'a Context<I, B>, loader: &'a mut L, ) -> Result<Value, Error>

where (): VocabularyMut<Iri = I, BlankId = B>, I: Clone + Hash + Eq, B: Clone + Hash + Eq, L: Loader,

impl<T> Debug for Indexed<T>

where T: Debug,

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

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, B> Extend<Indexed<Object<T, B>>> for ExpandedDocument<T, B>

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

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = Indexed<Object<T, B>>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬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, B> From<Indexed<Node<T, B>>> for ExpandedDocument<T, B>

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

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

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, B> FromIterator<Indexed<Object<T, B>>> for ExpandedDocument<T, B>

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

fn from_iter<I>(iter: I) -> ExpandedDocument<T, B>

where I: IntoIterator<Item = Indexed<Object<T, B>>>,

Creates a value from an iterator.

impl<T> Hash for Indexed<T>

where T: Hash,

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

where __H: Hasher,

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

where T: IntoJsonWithContext<N>,

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

impl<T> MappedEq for Indexed<T>

where T: MappedEq,

type BlankId = <T as MappedEq>::BlankId

fn mapped_eq<'a, 'b, F>(&'a self, other: &Indexed<T>, f: F) -> bool

where F: Clone + Fn(&'a <Indexed<T> as MappedEq>::BlankId) -> &'b <Indexed<T> as MappedEq>::BlankId, <Indexed<T> as MappedEq>::BlankId: 'a + 'b,

Structural equality with mapped blank identifiers.

impl<T> Ord for Indexed<T>

where T: Ord,

fn cmp(&self, other: &Indexed<T>) -> 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.

impl<T> PartialEq for Indexed<T>

where T: PartialEq,

fn eq(&self, other: &Indexed<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd for Indexed<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &Indexed<T>) -> 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> PrecomputeSizeWithContext<N> for Indexed<Node<T, B>>

where N: Vocabulary<Iri = T, BlankId = B>,

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

impl<T, B, N> PrecomputeSizeWithContext<N> for Indexed<Object<T, B>>

where N: Vocabulary<Iri = T, BlankId = B>,

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

impl<T, B, N> PrintWithSizeAndContext<N> for Indexed<Node<T, B>>

where N: Vocabulary<Iri = T, BlankId = B>,

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

impl<T, B, N> PrintWithSizeAndContext<N> for Indexed<Object<T, B>>

where N: Vocabulary<Iri = T, BlankId = B>,

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

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

where O: TryFromJsonObject<T, B>,

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

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

where O: TryFromJsonObject<T, B>,

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

impl<T> Eq for Indexed<T>

where T: Eq,

impl<T> StructuralPartialEq for Indexed<T>