Struct Atom

pub struct Atom<T> { /* private fields */ }

Atoms are the base primitive values in rust-kdb. You can create a new atom by calling KBox::new_atom, or using the From/Into traits on a value.

Examples

use kdb::{KBox, Atom};

let a = KBox::new_atom(42u8); // Creates a KBox<Atom<u8>>
let b: KBox<Atom<u8>> = 27u8.into();
println!("{} dudes!", a.value() + b.value());

Implementations

impl<T: KValue> Atom<T>

pub fn value(&self) -> T

Returns a copy of the value stored in the atom.

Examples found in repository

examples/using_atoms.rs (line 8)

fn main() {
    let mut k = KBox::new_atom(42u8);
    println!("{}", k);
    assert_eq!(k.value(), 42);

    k.set_value(43);

    assert_eq!(k.value(), 43);
}

examples/connecting_to_kdb.rs (line 6)

fn main() -> Result<(), ConnectionError> {
    let conn = Connection::connect("127.0.0.1", 4200, "", None)?;
    let result = cast!(conn.eval("2+2").unwrap(); Atom<i64>);
    println!("{}", result.value());

    //Returning a list of symbols
    let result = cast!(conn.eval("`a`b`c").unwrap(); List<Symbol>);
    println!("{:?}", &result[0..]);

    Ok(())
}

examples/fun_with_symbols.rs (line 15)

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 fn set_value(&mut self, val: T)

Changes the value stored in th atom.

Examples found in repository

examples/using_atoms.rs (line 10)

fn main() {
    let mut k = KBox::new_atom(42u8);
    println!("{}", k);
    assert_eq!(k.value(), 42);

    k.set_value(43);

    assert_eq!(k.value(), 43);
}

Trait Implementations

impl<T: KValue> AsRef<Any> for Atom<T>

fn as_ref(&self) -> &Any

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: KValue + Debug> Debug for Atom<T>

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

Formats the value using the given formatter.

impl<T: KValue + Display> Display for Atom<T>

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

Formats the value using the given formatter.

impl From<Atom<Date>> for Date

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

Converts to this type from the input type.

impl From<Atom<DateTime>> for DateTime

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

Converts to this type from the input type.

impl From<Atom<Minute>> for Minute

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

Converts to this type from the input type.

impl From<Atom<Month>> for Month

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

Converts to this type from the input type.

impl From<Atom<Second>> for Second

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

Converts to this type from the input type.

impl From<Atom<Symbol>> for Symbol

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

Converts to this type from the input type.

impl From<Atom<Time>> for Time

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

Converts to this type from the input type.

impl From<Atom<Timespan>> for Timespan

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

Converts to this type from the input type.

impl From<Atom<Timestamp>> for Timestamp

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

Converts to this type from the input type.

impl From<Atom<Uuid>> for Uuid

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

Converts to this type from the input type.

impl From<Atom<bool>> for bool

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

Converts to this type from the input type.

impl From<Atom<f32>> for f32

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

Converts to this type from the input type.

impl From<Atom<f64>> for f64

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

Converts to this type from the input type.

impl From<Atom<i16>> for i16

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

Converts to this type from the input type.

impl From<Atom<i32>> for i32

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

Converts to this type from the input type.

impl From<Atom<i64>> for i64

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

Converts to this type from the input type.

impl From<Atom<i8>> for i8

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

Converts to this type from the input type.

impl From<Atom<u8>> for u8

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

Converts to this type from the input type.