Struct Cell 

pub struct Cell<T: CellItem> { /* private fields */ }

Available on non-crate feature lock only.

A CSPICE cell holding elements of type T.

The backing storage is owned, and released when the cell is dropped.

Implementations

impl<T: CellItem> Cell<T>

pub fn new(size: usize) -> Self

Allocate a cell able to hold size elements.

Character cells get slots of CELL_MAX_LEN bytes; use Cell::with_length to choose.

pub fn with_length(size: usize, length: usize) -> Self

Allocate a cell able to hold size elements whose slots are length items long.

length is only meaningful for character cells, where it is the maximum length of an element.

pub fn len(&self) -> usize

Number of elements currently held, the cardinality in SPICE terms.

pub fn is_empty(&self) -> bool

Whether the cell holds no element.

pub fn capacity(&self) -> usize

Number of elements the cell can hold.

pub fn get(&self, index: usize) -> Option<T>

The element at index, or None past the cardinality.

pub fn iter(&self) -> impl Iterator<Item = T> + '_

Iterate over the elements currently held.

pub fn to_vec(&self) -> Vec<T>

Collect the elements currently held.

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

Append an element, provided the cell is not full.

pub fn clear(&mut self)

Drop every element, keeping the allocation.

pub fn as_ptr(&self) -> *const SpiceCell

The cell descriptor, for calls to the unsafe C API.

pub fn as_mut_ptr(&mut self) -> *mut SpiceCell

The cell descriptor, for calls to the unsafe C API.

The base and data pointers are refreshed from the backing buffer on every call, so the descriptor handed out is always the one CSPICE should write through.

impl Cell<i32>

pub fn new_int(size: i32) -> Self

Allocate an integer cell able to hold size elements.

pub fn new_bool(size: i32) -> Self

Allocate a boolean cell able to hold size elements.

pub fn get_data_int(&self, index: usize) -> i32

The element at index, or 0 past the cardinality.

pub fn get_data_bool(&self, index: usize) -> i32

The element at index as a boolean flag, or 0 past the cardinality.

impl Cell<f64>

pub fn new_double(size: i32) -> Self

Allocate a double precision cell able to hold size elements.

pub fn new_time(size: i32) -> Self

Allocate a time cell able to hold size elements.

pub fn get_data_double(&self, index: usize) -> f64

The element at index, or 0.0 past the cardinality.

impl Cell<String>

pub fn new_character(size: i32, length: i32) -> Self

Allocate a character cell able to hold size elements of at most length bytes.

pub fn get_data_character(&self, index: usize) -> String

The element at index, or the empty string past the cardinality.

Trait Implementations

impl<T: CellItem> Clone for Cell<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: CellItem + Debug> Debug for Cell<T>

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

Formats the value using the given formatter.

impl<T: CellItem> Deref for Cell<T>

Read only access to the raw descriptor, for the card and size fields CSPICE maintains.

type Target = _SpiceCell

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: CellItem + Send> Send for Cell<T>

impl<'a, T: CellItem> SpiceArg for &'a mut Cell<T>

A pointer to a cell, for the wrappers that take one as an input.

type Owned = &'a mut Cell<T>

Scratch storage that has to outlive the call, Self when nothing has to be allocated.

type Raw = *mut _SpiceCell

The value actually passed to the C routine.

fn own(self) -> Self::Owned

Move the value into its scratch storage.

fn raw(owned: &mut Self::Owned) -> Self::Raw

Borrow the scratch storage as the C representation.