Enum json_ld::syntax::Keyword

pub enum Keyword {
    Base,
    Container,
    Context,
    Direction,
    Graph,
    Id,
    Import,
    Included,
    Index,
    Json,
    Language,
    List,
    Nest,
    None,
    Prefix,
    Propagate,
    Protected,
    Reverse,
    Set,
    Type,
    Value,
    Version,
    Vocab,
}

JSON-LD keywords.

Variants

Base

@base. Used to set the base IRI against which to resolve those relative IRI references which are otherwise interpreted relative to the document.

Container

@container. Used to set the default container type for a term.

Context

@context. Used to define the short-hand names that are used throughout a JSON-LD document.

Direction

@direction. Used to set the base direction of a JSON-LD value, which are not typed values. (e.g. strings, or language-tagged strings).

Graph

@graph. Used to express a graph.

Id

@id. Used to uniquely identify node objects that are being described in the document with IRIs or blank node identifiers.

Import

@import. Used in a context definition to load an external context within which the containing context definition is merged.

Included

@included. Used in a top-level node object to define an included block, for including secondary node objects within another node object.

Index

@index. Used to specify that a container is used to index information and that processing should continue deeper into a JSON data structure.

Json

@json. Used as the @type value of a JSON literal.

Language

@language. Used to specify the language for a particular string value or the default language of a JSON-LD document.

List

@list. Used to express an ordered set of data.

Nest

@nest. Used to define a property of a node object that groups together properties of that node, but is not an edge in the graph.

None

@none. Used as an index value in an index map, id map, language map, type map, or elsewhere where a map is used to index into other values, when the indexed node does not have the feature being indexed.

Prefix

@prefix. With the value true, allows this term to be used to construct a compact IRI when compacting.

Propagate

@propagate. Used in a context definition to change the scope of that context.

By default, it is true, meaning that contexts propagate across node objects (other than for type-scoped contexts, which default to false). Setting this to false causes term definitions created within that context to be removed when entering a new node object.

Protected

@protected. Used to prevent term definitions of a context to be overridden by other contexts.

Reverse

@reverse. Used to express reverse properties.

Set

@set. Used to express an unordered set of data and to ensure that values are always represented as arrays.

Type

@type. Used to set the type of a node or the datatype of a typed value.

Value

@value. Used to specify the data that is associated with a particular property in the graph.

Version

@version. Used in a context definition to set the processing mode.

Vocab

@vocab. Used to expand properties and values in @type with a common prefix IRI.

Methods

impl Keyword

pub fn into_str(self) -> &'static str

Trait Implementations

impl AsJson for Keyword

fn as_json(&self) -> JsonValue

impl Clone for Keyword

fn clone(&self) -> Keyword

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Keyword

impl Debug for Keyword

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

Formats the value using the given formatter.

impl Display for Keyword

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

Formats the value using the given formatter.

impl Eq for Keyword

impl From<Keyword> for &'static str

fn from(k: Keyword) -> &'static str

Performs the conversion.

impl Hash for Keyword

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Keyword

fn cmp(&self, other: &Keyword) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Keyword> for Keyword

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Keyword> for Keyword

fn partial_cmp(&self, other: &Keyword) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Keyword

impl StructuralPartialEq for Keyword

impl<'a> TryFrom<&'a str> for Keyword

type Error = &'a str

The type returned in the event of a conversion error.

fn try_from(str: &'a str) -> Result<Keyword, &'a str>

Performs the conversion.