Struct JsonLdExpandedDocument 

pub struct JsonLdExpandedDocument(/* private fields */);

Result of the document expansion algorithm.

It is just an alias for a set of (indexed) objects.

Implementations

impl JsonLdExpandedDocument

pub async fn compact_with( &self, env: impl AsyncJsonLdEnvironment, context: &JsonLdProcessedContext<'_>, options: JsonLdCompactionOptions, location: JsonLdBacktraceBuilder<'_>, ) -> Result<JsonValue, JsonLdLocatedError>

Compacts the input document with the given options, starting the location backtrace at location.

pub async fn compact( &self, env: impl AsyncJsonLdEnvironment, context: &JsonLdProcessedContext<'_>, location: JsonLdBacktraceBuilder<'_>, ) -> Result<JsonValue, JsonLdLocatedError>

Compacts the input document with the default options, starting the location backtrace at location.

impl JsonLdExpandedDocument

pub fn generate_node_map_with( &self, generator: impl Generator, location: JsonLdBacktraceBuilder<'_>, ) -> Result<JsonLdNodeMap, Box<JsonLdLocated<ConflictingIndexes>>>

impl JsonLdExpandedDocument

pub fn flatten( &self, generator: impl Generator, ordered: bool, location: JsonLdBacktraceBuilder<'_>, ) -> Result<JsonLdFlattenedDocument, Box<JsonLdLocated<ConflictingIndexes>>>

pub fn flatten_unordered( &self, generator: impl Generator, location: JsonLdBacktraceBuilder<'_>, ) -> Result<JsonLdUnorderedFlattenedDocument, Box<JsonLdLocated<ConflictingIndexes>>>

impl JsonLdExpandedDocument

pub fn new() -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn objects(&self) -> &BTreeIndexSet<JsonLdIndexedObject>

pub fn into_objects(self) -> BTreeIndexSet<JsonLdIndexedObject>

pub fn iter(&self) -> Iter<'_, JsonLdIndexedObject>

pub fn main_node(&self) -> Option<&JsonLdNode>

Returns the main node object of the document, if any.

The main node is the unique top level (root) node object. If multiple node objects are on the root, None is returned.

pub fn into_main_node(self) -> Option<JsonLdNode>

Consumes the document and returns its main node object, if any.

The main node is the unique top level (root) node object. If multiple node objects are on the root, None is returned.

pub fn insert(&mut self, object: JsonLdIndexedObject) -> bool

impl JsonLdExpandedDocument

pub fn to_json(&self) -> JsonValue

Returns the JSON representation of this expanded document, that is a JSON array of its expanded objects.

Trait Implementations

impl Clone for JsonLdExpandedDocument

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonLdExpandedDocument

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

Formats the value using the given formatter.

impl Default for JsonLdExpandedDocument

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonLdExpandedDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R> DeserializeLinkedData<R> for JsonLdExpandedDocument

where R: Clone + Ord,

fn deserialize_rdf<D>( deserializer: D, graph: Option<&R>, ) -> Result<Self, D::Error>

where D: LinkedDataDeserializer<R>,

fn deserialize_rdf_objects<D>( deserializer: D, subject: &R, predicate: &R, graph: Option<&R>, ) -> Result<Self, <D as LinkedDataDeserializer<R>>::Error>

where D: LinkedDataDeserializer<R>,

impl Eq for JsonLdExpandedDocument

impl Extend<JsonLdIndexed<JsonLdObject>> for JsonLdExpandedDocument

fn extend<I: IntoIterator<Item = JsonLdIndexedObject>>(&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 From<BTreeIndexSet<JsonLdIndexed<JsonLdObject>>> for JsonLdExpandedDocument

fn from(set: BTreeIndexSet<JsonLdIndexedObject>) -> Self

Converts to this type from the input type.

impl From<JsonLdExpandedDocument> for JsonValue

Available on crate feature serde only.

fn from(document: JsonLdExpandedDocument) -> Self

Converts to this type from the input type.

impl From<JsonLdIndexed<JsonLdNode>> for JsonLdExpandedDocument

fn from(value: JsonLdIndexed<JsonLdNode>) -> Self

Converts to this type from the input type.

impl FromIterator<JsonLdIndexed<JsonLdObject>> for JsonLdExpandedDocument

fn from_iter<I: IntoIterator<Item = JsonLdIndexedObject>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for JsonLdExpandedDocument

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 IntoIterator for JsonLdExpandedDocument

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

type Item = JsonLdIndexed<JsonLdObject>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a JsonLdExpandedDocument

type IntoIter = Iter<'a, JsonLdIndexed<JsonLdObject>>

Which kind of iterator are we turning this into?

type Item = &'a JsonLdIndexed<JsonLdObject>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl JsonLdCompact for JsonLdExpandedDocument

async fn compact_with( &self, env: impl AsyncJsonLdEnvironment, context: &JsonLdProcessedContext<'_>, options: JsonLdCompactionOptions, location: JsonLdBacktraceBuilder<'_>, ) -> Result<JsonValue, JsonLdLocatedError>

Compacts the input document with the given options.

async fn compact( &self, env: impl AsyncJsonLdEnvironment, context: &JsonLdProcessedContext<'_>, location: JsonLdBacktraceBuilder<'_>, ) -> Result<JsonValue, JsonLdLocatedError>

Compacts the input document with the default options.

impl JsonLdVisit for JsonLdExpandedDocument

fn visit_with(&self, f: &mut impl FnMut(JsonLdObjectRef<'_>))

fn visit_mut_with(&mut self, f: &mut impl FnMut(JsonLdObjectMut<'_>))

fn visit(&self, f: impl FnMut(JsonLdObjectRef<'_>))

fn visit_mut(&mut self, f: impl FnMut(JsonLdObjectMut<'_>))

fn relabel_with(&mut self, relabeling: &mut JsonLdRelabeling<impl Generator>)

fn relabel<G: Generator>(&mut self, generator: G) -> JsonLdRelabeling<G>

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

fn canonicalize(&mut self)

fn relabel_and_canonicalize_with( &mut self, relabeling: &mut JsonLdRelabeling<impl Generator>, buffer: &mut Buffer, )

fn relabel_and_canonicalize<G: Generator>( &mut self, generator: G, ) -> JsonLdRelabeling<G>

impl Ord for JsonLdExpandedDocument

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 PartialEq for JsonLdExpandedDocument

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for JsonLdExpandedDocument

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 Serialize for JsonLdExpandedDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SerializeLinkedData for JsonLdExpandedDocument

fn serialize_rdf<S>( &self, serializer: S, graph: Option<&Term>, ) -> Result<S::Ok, S::Error>

where S: LinkedDataSerializer<Term>,

fn serialize_rdf_subjects<S>( &self, serializer: S, predicate: &R, object: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_objects<S>( &self, serializer: S, subject: &R, predicate: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_graph<S>( &self, serializer: S, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

Serialize quads, ignoring top level resources.

impl SerializeLinkedDataWith<RdfSerializationOptions> for JsonLdExpandedDocument

fn serialize_rdf_with<S>( &self, opts: RdfSerializationOptions, serializer: S, graph: Option<&Term>, ) -> Result<S::Ok, S::Error>

where S: LinkedDataSerializer<Term>,

fn serialize_rdf_subjects_with<S>( &self, state: Q, serializer: S, predicate: &R, object: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_objects_with<S>( &self, state: Q, serializer: S, subject: &R, predicate: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_graph_with<S>( &self, state: Q, serializer: S, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

Serialize quads, ignoring top level resources.

impl StructuralPartialEq for JsonLdExpandedDocument