Struct mentat_ffi::NamespacedKeyword

pub struct NamespacedKeyword {
    pub namespace: String,
    pub name: String,
}

Fields

namespace: String

name: String

Methods

impl NamespacedKeyword

pub fn new<T>(namespace: T, name: T) -> NamespacedKeyword where
    T: Into<String>, 

Creates a new NamespacedKeyword.

Examples

let keyword = NamespacedKeyword::new("foo", "bar");
assert_eq!(keyword.to_string(), ":foo/bar");

See also the kw! macro in the main mentat crate.

pub fn is_backward(&self) -> bool

Whether this NamespacedKeyword should be interpreted in reverse order. For example, the two following snippets are identical:

[?y :person/friend ?x]
[?x :person/hired ?y]

[?y :person/friend ?x]
[?y :person/_hired ?x]

Examples

assert!(!NamespacedKeyword::new("foo", "bar").is_backward());
assert!(NamespacedKeyword::new("foo", "_bar").is_backward());

pub fn is_forward(&self) -> bool

Whether this NamespacedKeyword should be interpreted in forward order. See symbols::NamespacedKeyword::is_backward.

Examples

assert!(NamespacedKeyword::new("foo", "bar").is_forward());
assert!(!NamespacedKeyword::new("foo", "_bar").is_forward());

pub fn to_reversed(&self) -> NamespacedKeyword

Returns a NamespacedKeyword with the same namespace and a 'backward' name. See symbols::NamespacedKeyword::is_backward.

Examples

let nsk = NamespacedKeyword::new("foo", "bar");
assert!(!nsk.is_backward());
assert_eq!(":foo/bar", nsk.to_string());

let reversed = nsk.to_reversed();
assert!(reversed.is_backward());
assert_eq!(":foo/_bar", reversed.to_string());

pub fn unreversed(&self) -> Option<NamespacedKeyword>

If this NamespacedKeyword is 'backward' (see symbols::NamespacedKeyword::is_backward), return Some('forward name'); otherwise, return None.

Examples

let nsk = NamespacedKeyword::new("foo", "bar");
assert_eq!(None, nsk.unreversed());

let reversed = nsk.to_reversed();
assert_eq!(Some(nsk), reversed.unreversed());

Trait Implementations

impl Hash for NamespacedKeyword

fn hash<__H>(&self, __arg_0: &mut __H) where
    __H: Hasher, 

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 PartialOrd<NamespacedKeyword> for NamespacedKeyword

fn partial_cmp(&self, __arg_0: &NamespacedKeyword) -> Option<Ordering>

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

fn lt(&self, __arg_0: &NamespacedKeyword) -> bool

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

fn le(&self, __arg_0: &NamespacedKeyword) -> bool

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

fn gt(&self, __arg_0: &NamespacedKeyword) -> bool

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

fn ge(&self, __arg_0: &NamespacedKeyword) -> bool

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

impl<'de> Deserialize<'de> for NamespacedKeyword

fn deserialize<__D>(
    __deserializer: __D
) -> Result<NamespacedKeyword, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Debug for NamespacedKeyword

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Clone for NamespacedKeyword

fn clone(&self) -> NamespacedKeyword

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Serialize for NamespacedKeyword

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

Serialize this value into the given Serde serializer.

impl Ord for NamespacedKeyword

fn cmp(&self, __arg_0: &NamespacedKeyword) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Display for NamespacedKeyword

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

Print the keyword in EDN format.

Examples

assert_eq!(":bar/baz", NamespacedKeyword::new("bar", "baz").to_string());
assert_eq!(":bar/_baz", NamespacedKeyword::new("bar", "baz").to_reversed().to_string());
assert_eq!(":bar/baz", NamespacedKeyword::new("bar", "baz").to_reversed().to_reversed().to_string());

impl Eq for NamespacedKeyword

impl PartialEq<NamespacedKeyword> for NamespacedKeyword

fn eq(&self, __arg_0: &NamespacedKeyword) -> bool

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

fn ne(&self, __arg_0: &NamespacedKeyword) -> bool

This method tests for !=.

impl From<NamespacedKeyword> for TypedValue

fn from(value: NamespacedKeyword) -> TypedValue

Performs the conversion.