Struct json_ld::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 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 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 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.

impl<J: JsonHash, T: Id> Indexed<Object<J, T>>

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

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

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

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

pub fn into_indexed_list(self) -> Option<Indexed<Vec<Self>>>

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

pub fn into_unnamed_graph(self) -> Result<HashSet<Self>, Self>

Try to convert this object into an unnamed graph.

Trait Implementations

impl<J: JsonClone, K: JsonFrom<J>, T: AsJson<J, K>> AsJson<J, K> for Indexed<T>

fn as_json_with(
    &self,
    meta: impl Clone + Fn(Option<&J::MetaData>) -> K::MetaData
) -> K

Converts this value into a K JSON value using the given meta function to convert J::MetaData into K::MetaData.

fn as_json(&self) -> K where
    K::MetaData: Default, 

Converts this value into a K JSON value.

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

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

Performs the conversion.

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

fn as_ref(&self) -> &T

Performs the conversion.

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<J: JsonSrc, T: Sync + Send + Id, V: Sync + Send + CompactIndexed<J, T>> Compact<J, T> for Indexed<V>

fn compact_full<'a, K: JsonFrom<J>, C: ContextMut<T>, L: Loader, M>(
    &'a self,
    active_context: Inversible<T, &'a C>,
    type_scoped_context: Inversible<T, &'a C>,
    active_property: Option<&'a str>,
    loader: &'a mut L,
    options: Options,
    meta: M
) -> BoxFuture<'a, Result<K, Error>> where
    J: 'a,
    T: 'a,
    C: Sync + Send,
    C::LocalContext: Send + Sync + From<L::Output>,
    L: Sync + Send,
    M: 'a + Send + Sync + Clone + Fn(Option<&J::MetaData>) -> K::MetaData, 

Compact a JSON-LD document into a K JSON value with the provided type scoped context, active property and options.

fn compact_with<'a, K: JsonFrom<J>, C: ContextMut<T>, L: Loader, M>(
    &'a self,
    active_context: Inversible<T, &'a C>,
    loader: &'a mut L,
    options: Options,
    meta: M
) -> BoxFuture<'a, Result<K, Error>> where
    Self: Sync,
    T: 'a + Sync + Send,
    C: Sync + Send,
    C::LocalContext: Send + Sync + From<L::Output>,
    L: Sync + Send,
    M: 'a + Send + Sync + Clone + Fn(Option<&J::MetaData>) -> K::MetaData, 

Compact a JSON-LD document into a K JSON value with the provided options.

fn compact<'a, K: JsonFrom<J>, C: ContextMut<T>, L: Loader, M>(
    &'a self,
    active_context: Inversible<T, &'a C>,
    loader: &'a mut L,
    meta: M
) -> BoxFuture<'a, Result<K, Error>> where
    Self: Sync,
    T: 'a + Sync + Send,
    C: Sync + Send,
    C::LocalContext: Send + Sync + From<L::Output>,
    L: Sync + Send,
    M: 'a + Send + Sync + Clone + Fn(Option<&J::MetaData>) -> K::MetaData, 

Compact a JSON-LD document into a K JSON value with the default options.

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

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

Performs the conversion.

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

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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 !=.

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