Struct kdb::KBox

#[repr(transparent)]pub struct KBox<T: KObject> { /* fields omitted */ }

Represents a memory managed K pointer. They are the KDB equivalent of a Rust Box, a zero overhead wrapper around a K pointer. It will call r0 to decrement the reference count when it is dropped.

Implementations

impl<T: KValue> KBox<Atom<T>>

pub fn new_atom(value: T) -> KBox<Atom<T>>

Creates a new atom with the specified value.

impl KBox<Dictionary>

pub fn new_dict() -> Self

Create a new empty dictionary.

impl KBox<KError>

pub fn new_error(msg: &str) -> Self

Create a new KDB error from the specified string.

impl<T: KObject> KBox<T>

pub fn into_raw(self) -> *mut T

Converts a box into a raw unmanged K pointer. Note that into raw will consume the KBox, and not call r0, so it's possible to leak memory by doing this.

pub unsafe fn from_raw(k: *mut K) -> Self

Converts a raw K pointer into a boxed K object. This is the reciprocal of into_raw

Safety

The type of the k pointer must match the type of the KBox being used. Do not use this to take ownership of a kdb callback function parameter, use from_shared instead.

pub unsafe fn from_shared(t: &mut T) -> Self

Takes a reference and calls r1, incrementing the reference count and "re-boxing" it. Typically this is a bad thing as you have multiple owned references and kdb does not provide equivalent guarantees to rust about what happens to shared references (especially when reallocating a list for example)

However in the embedded case, where you do not own the parameter and you wish to manipulate it without copying the data, then you need this functionality.

Safety

A reference should not be owned by more than one KBox instance.

impl<T: KListable> KBox<List<T>>

pub fn new_list() -> Self

Creates a new empty list.

Note that if you are converting a rust collection to a list, collect is a more efficient. If you are creating a list with a set of known elements, use the list! macro.

pub fn join(&mut self, list: KBox<List<T>>)

Appends a list to this one, consuming it and adding it's elements to the new one.

pub fn push(&mut self, item: T::ListItem)

Appends an element to the end of the list.

Trait Implementations

impl<T: KObject> AsRef<T> for KBox<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: KObject + Debug> Debug for KBox<T>

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

Formats the value using the given formatter.

impl<T: KObject> Deref for KBox<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: KObject> DerefMut for KBox<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: KObject + Display> Display for KBox<T>

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

Formats the value using the given formatter.

impl<T: KObject> Drop for KBox<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Eq + KObject> Eq for KBox<T>

impl<T: KListable> Extend<<T as KListable>::ListItem> for KBox<List<T>>

fn extend<I: IntoIterator<Item = T::ListItem>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: KValue> From<KBox<Atom<T>>> for KBox<Any>

fn from(value: KBox<Atom<T>>) -> Self

Performs the conversion.

impl From<KBox<Dictionary>> for KBox<Any>

fn from(value: KBox<Dictionary>) -> Self

Performs the conversion.

impl From<KBox<KError>> for Error

fn from(ke: KBox<KError>) -> Self

Performs the conversion.

impl<T: KListable> From<KBox<List<T>>> for KBox<Any>

fn from(value: KBox<List<T>>) -> Self

Performs the conversion.

impl From<KBox<Table>> for KBox<Any>

fn from(value: KBox<Table>) -> Self

Performs the conversion.

impl<T: KValue> From<T> for KBox<Any>

fn from(value: T) -> Self

Performs the conversion.

impl<T: KValue> From<T> for KBox<Atom<T>>

fn from(val: T) -> KBox<Atom<T>>

Performs the conversion.

impl<T: KListable> FromIterator<<T as KListable>::ListItem> for KBox<List<T>>

fn from_iter<I: IntoIterator<Item = T::ListItem>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash + KObject> Hash for KBox<T>

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord + KObject> Ord for KBox<T>

fn cmp(&self, other: &KBox<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq + KObject> PartialEq<KBox<T>> for KBox<T>

fn eq(&self, other: &KBox<T>) -> bool

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

fn ne(&self, other: &KBox<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + KObject> PartialOrd<KBox<T>> for KBox<T>

fn partial_cmp(&self, other: &KBox<T>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<T: KObject> StructuralEq for KBox<T>

impl<T: KObject> StructuralPartialEq for KBox<T>

impl<T> TryFrom<KBox<Any>> for KBox<Atom<T>> where
    T: KValue, 

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(any: KBox<Any>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<KBox<Any>> for KBox<List<T>> where
    T: KListable, 

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(any: KBox<Any>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<KBox<Any>> for KBox<Dictionary>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(any: KBox<Any>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<KBox<Any>> for KBox<Table>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(any: KBox<Any>) -> Result<Self, Self::Error>

Performs the conversion.