Struct Key 

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

Context key.

A key of up to 23 bytes is stored inline, so creating, cloning and dropping it allocates nothing and touches no shared counter; nearly every term of a real context is that short. A longer key is shared behind a reference count.

A key owns its string and frees it when dropped, so the memory a process spends on keys is bounded by the contexts it keeps.

Equality, ordering and hashing are those of the string, so a map keyed by Key can be searched with a &str.

Implementations

impl Key

pub fn as_iri(&self) -> Option<Iri<&str>>

Parses this key as an IRI, returning None if it is not one.

pub fn as_compact_iri(&self) -> Option<&CompactIri>

Parses this key as a compact IRI, returning None if it is not one.

pub fn as_blank_id(&self) -> Option<&BlankId>

Parses this key as a blank node identifier, returning None if it is not one.

pub fn as_str(&self) -> &str

Returns the string of this key.

pub fn len(&self) -> usize

Returns the length of this key, in bytes.

pub fn is_empty(&self) -> bool

Checks whether this key is the empty string.

pub fn into_string(self) -> String

Copies this key into a newly allocated String.

pub fn is_keyword_like(&self) -> bool

Checks whether this key is keyword-like: an @ followed by ASCII letters. See crate::is_keyword_like.

Trait Implementations

impl Borrow<str> for Key

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Key

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 Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl<'a> From<&'a Key> for KeyRef<'a>

fn from(k: &'a Key) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Key> for KeyOrKeywordRef<'a>

fn from(k: &'a Key) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Key

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl From<CompactString> for Key

fn from(k: Key) -> Self

Converts to this type from the input type.

impl From<String> for Key

fn from(k: String) -> Self

Converts to this type from the input type.

impl Hash for Key

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 IntoJson for Key

fn into_json(self) -> Value

Converts this value into JSON.

impl Ord for Key

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 Key

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Key

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 PrecomputeSize for Key

fn pre_compute_size(&self, _options: &Options, _sizes: &mut Vec<Size>) -> Size

Computes the printed size of this value, appending the size of each nested array and object to sizes.

impl Print for Key

fn fmt_with( &self, f: &mut Formatter<'_>, _options: &Options, _indent: usize, ) -> Result

Writes the value to f with the given options, starting at the given indentation level.

fn pretty_print(&self) -> Printed<'_, Self>

Print the value with Options::pretty options.

fn compact_print(&self) -> Printed<'_, Self>

Print the value with Options::compact options.

fn inline_print(&self) -> Printed<'_, Self>

Print the value with Options::inline options.

fn print_with(&self, options: Options) -> Printed<'_, Self>

Print the value with the given options.

impl Serialize for Key

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Key

impl TryFromJson for Key

type Error = InvalidContext

Error raised when the JSON value does not describe a valid Self.

fn try_from_json(value: &Value) -> Result<Self, Self::Error>

Builds a value of this type from the given JSON value.