Struct Key 

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

A value as an index looks it up.

Built from what the caller is searching for, or from what was found at a path in a document being written. The two go through the same code on purpose, because a query that encodes its argument differently from the way the write encoded the document is a query that finds nothing and says nothing about why.

Implementations

impl Key

pub fn null() -> Key

The key for null.

pub fn bool(v: bool) -> Key

The key for a boolean.

pub fn int(v: i64) -> Key

The key for an integer.

pub fn float(v: f64) -> Key

The key for a float.

A float and an integer that name the same number get the same key, so 7.0 and 7 are one key and a search for either finds both.

pub fn text(v: &str) -> Key

The key for a string.

pub fn text_bytes(v: &[u8]) -> Key

The key for a string that is already bytes.

pub fn word(v: &str) -> Option<Key>

The key one word is filed under in a text index, or None if this is not one word.

A search against a text index goes through this rather than Key::text, because a text index folds case when it files a document and a search that does not fold it finds nothing and says nothing about why. Anything that is not letters and digits is a separator, so a phrase is two words and answers None: matching one is a search this index cannot answer on its own, rather than a search for the first word.

pub fn of(v: Value<'_>) -> Option<Key>

The key for a value found in a document, or None if it is a container and so has no equality key.

pub fn as_bytes(&self) -> &[u8]

The bytes this is filed under.

pub fn is_too_long(&self) -> bool

Whether this key is too long to file.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

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<(), Error>

Formats the value using the given formatter.

impl Eq for Key

impl PartialEq for Key

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

Equality operator ==.

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

Inequality operator !=.