Struct ValueHint 

pub struct ValueHint<'a, T, B> {
    pub kind: ValueKind<'a, T, B>,
    pub indexed: bool,
}

Describes a value to IRI compaction without materializing it.

IRI compaction picks the term for a property by looking at the value that will be written under it: its kind (node, value, list or graph object), its @type, @language and @direction, its @id and whether it has an @index. compact_iri_with reads all of that off an expanded Indexed object; compact_iri_with_hint reads it off this hint instead, so a caller walking its own data model can select terms without first building jsonld-core objects.

A hint selects exactly the term the described object would select: both entry points derive the container list and the type/language preference of term selection through the same code.

Fields

kind: ValueKind<'a, T, B>

Kind of the described value.

indexed: bool

Whether the described value carries an @index entry.

Implementations

impl<'a, T, B> ValueHint<'a, T, B>

pub const fn new(kind: ValueKind<'a, T, B>) -> Self

Creates a hint for a value without an @index entry.

pub const fn indexed(kind: ValueKind<'a, T, B>) -> Self

Creates a hint for a value carrying an @index entry.

Trait Implementations

impl<'a, T, B> Clone for ValueHint<'a, 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<'a, T, B> Copy for ValueHint<'a, T, B>

impl<'a, T, B> Debug for ValueHint<'a, T, B>

where T: Debug, B: Debug,

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

Formats the value using the given formatter.