Struct json_ld::Options

source · [−]

pub struct Options<I = Index, M = Location<I>, C = Value<M>> {
    pub base: Option<I>,
    pub compact_arrays: bool,
    pub compact_to_relative: bool,
    pub expand_context: Option<RemoteDocumentReference<I, M, C>>,
    pub ordered: bool,
    pub processing_mode: ProcessingMode,
}

Fields

base: Option<I>

The base IRI to use when expanding or compacting the document.

If set, this overrides the input document’s IRI.

compact_arrays: bool

If set to true, the JSON-LD processor replaces arrays with just one element with that element during compaction.

If set to false, all arrays will remain arrays even if they have just one element.

Defaults to true.

compact_to_relative: bool

Determines if IRIs are compacted relative to the base option or document location when compacting.

Defaults to true.

expand_context: Option<RemoteDocumentReference<I, M, C>>

A context that is used to initialize the active context when expanding a document.

ordered: bool

If set to true, certain algorithm processing steps where indicated are ordered lexicographically.

If false, order is not considered in processing.

Defaults to false.

processing_mode: ProcessingMode

Sets the processing mode.

Defaults to ProcessingMode::JsonLd1_1.

Implementations

impl<I, M, C> Options<I, M, C>

pub fn unordered(self) -> Self

pub fn context_processing_options(&self) -> Options

pub fn expansion_options(&self) -> Options

pub fn compaction_options(&self) -> Options

Trait Implementations

impl<I: Clone, M: Clone, C: Clone> Clone for Options<I, M, C>

fn clone(&self) -> Options<I, M, C>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<I, M, C> Default for Options<I, M, C>

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl<I, M, C> RefUnwindSafe for Options<I, M, C>where
    C: RefUnwindSafe,
    I: RefUnwindSafe,
    M: RefUnwindSafe,

impl<I, M, C> Send for Options<I, M, C>where
    C: Send,
    I: Send,
    M: Send,

impl<I, M, C> Sync for Options<I, M, C>where
    C: Sync,
    I: Sync,
    M: Sync,

impl<I, M, C> Unpin for Options<I, M, C>where
    C: Unpin,
    I: Unpin,
    M: Unpin,

impl<I, M, C> UnwindSafe for Options<I, M, C>where
    C: UnwindSafe,
    I: UnwindSafe,
    M: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> At for T

fn at<M>(self, metadata: M) -> Meta<T, M>

Wraps self inside a Meta<Self, M> using the given metadata. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> BorrowStripped for T

fn stripped(&self) -> &Stripped<T>

impl<T> BorrowUnordered for T

fn unordered(&self) -> &Unordered<T>

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, B> IntoId<T, B> for T

type Id = Id<T, B>

The target type of the conversion, which can be borrowed as a Id<T, B>.

fn to_ref(self) -> <T as IntoId<T, B>>::Id

Convert the value into a reference.

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToOwned for T

type Owned = T

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithContext for Twhere
T: ?Sized,

fn with<C>(&self, context: C) -> Contextual<&T, C>

fn into_with<C>(self, context: C) -> Contextual<T, C>