Struct Symbol 

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

Represents a KDB Symbol (interned string) Implements basic symbol operations for efficiency Can be converted to/from strings

Implementations

impl Symbol

pub fn new<T: AsRef<str>>(st: T) -> Result<Symbol, SymbolError>

Create a new symbol from the specified string. If the string is too long, or contains an embedded nul character, then it returns an error.

Examples found in repository

examples/fun_with_symbols.rs (line 8)

fn main() {
    //Create two identical symbols in different ways, and check that they are equal.
    let sym = symbol("Hello, World");
    // Note: converting a string into a symbol is not an infallible operation
    // rust strings can contain embedded nuls, whereas symbols cannot.
    let sym_2 = Symbol::new(String::from("Hello") + ", World").unwrap();
    assert_eq!(sym, sym_2);

    // As an atom:
    let atom = KBox::new_atom(sym);
    let atom_2 = KBox::new_atom(Symbol::new(String::from("Hello") + ", World").unwrap());

    assert_eq!(atom.value(), atom_2.value());

    // Note that because rust strings are utf-8, and symbols have no encoding requirement,
    // this may not display the same way as you will see it in kdb, especially if the string is
    // not a valid ASCII or utf-8 string.
    println!("{}", sym);
}

pub unsafe fn new_unchecked<T: AsRef<str>>(st: T) -> Symbol

Creates a new symbol, skipping the safety checks for length

Safety

Any string passed in must not contain embedded nul characters (\0). It’s length must be less than or equal to isize::MAX.

pub fn try_as_str(&self) -> Result<&'static str, ConversionError>

Attempts to convert to a valid utf-8 string. This will return an error if the string contains invalid utf-8 characters. This function does not allocate.

pub unsafe fn as_str_unchecked(&self) -> &'static str

Converts the symbol to a rust str without checking if it is valid.

Safety

The string must be valid UTF-8. It’s length must be less than or equal to isize::MAX.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Display for Symbol

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

Display for symbol will always render a string representation of the symbol. If the string contains invalid characters it will strip them from the string. This function will allocate only if the string conatins invalid utf-8 characters.

impl From<Atom<Symbol>> for Symbol

fn from(val: Atom<Symbol>) -> Symbol

Converts to this type from the input type.

impl From<Symbol> for *const i8

fn from(sym: Symbol) -> Self

Converts to this type from the input type.

impl Hash for Symbol

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 PartialEq for Symbol

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Symbol

impl Eq for Symbol