Struct FieldData 

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

Data vector containing the data for a single field (column) of an agnes data store.

To support NA / missing values, a FieldData object is internally represented as a Vec of the appropriate type, along with a bit mask to denote valid / missing values.

Implementations

impl<T> FieldData<T>

pub fn len(&self) -> usize

Returns the length of this data vector.

pub fn is_empty(&self) -> bool

Returns true if this field contains no values.

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

Get the value at the given index. Returns None if index is out of bounds, or a Value enum.

pub fn take(&mut self, index: usize) -> Option<Value<T>>

where T: Default,

Take the value at the given index. Returns None if index is out of bounds, or a Value enum. Replaces the taken value with Value::Na.

pub fn as_vec(&self) -> Vec<Value<&T>>

where FieldData<T>: DataIndex<DType = T>,

Interpret FieldData as a Vec of Value objects.

pub fn from_boxed_slice(orig: Box<[T]>) -> Self

Create a new FieldData from a slice. Does not clone or reallocate the contained data (but does allocate the bit mask). Resulting FieldData struct will have no Value::Na values.

impl<T> FieldData<T>

pub fn from_vec<U: Into<T>>(v: Vec<U>) -> FieldData<T>

Create a FieldData struct from a vector of non-NA values. Resulting FieldData struct will have no Value::Na values.

impl<T> FieldData<T>

where T: Debug + Default,

pub fn push_val(&mut self, value: Value<T>)

Add a new value (or an indication of a missing one) to the data vector.

impl<T> FieldData<T>

where T: Debug + Default + Clone,

pub fn push_ref(&mut self, value: Value<&T>)

Add a new value (passed by reference) to the data vector.

pub fn from_field_vec(v: Vec<Value<T>>) -> FieldData<T>

Create a FieldData struct from a vector of field values.

Trait Implementations

impl<T: Clone> Clone for FieldData<T>

fn clone(&self) -> FieldData<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> DataIndex for FieldData<T>

where T: Debug,

type DType = T

The data type contained within this field.

fn get_datum(&self, idx: usize) -> Result<Value<&T>>

Returns the data (possibly NA) at the specified index, if it exists.

fn len(&self) -> usize

Returns the length of this data field.

fn is_empty(&self) -> bool

Returns whether or not this field is empty.

fn iter(&self) -> DataIterator<'_, Self::DType>

where Self: Sized,

Returns an iterator over the values in this field.

fn permute(self, permutation: &[usize]) -> Framed<Self::DType, Self>

where Self: Sized,

Returns a new DataIndex-implementing object which provides access to the values in this field as permuted by permutation. permutation is a slice of indices into this DataIndex.

fn to_vec(&self) -> Vec<Self::DType>

where Self: Sized, Self::DType: Clone,

Copies existing values in this field into a new Vec.

fn to_value_vec(&self) -> Vec<Value<Self::DType>>

where Self: Sized, Self::DType: Clone,

Copies values (missing or existing) in this field into a new Vec.

impl<T> DataIndexMut for FieldData<T>

where T: Debug + Default,

fn push(&mut self, value: Value<Self::DType>)

Add a value to this field.

fn take_datum(&mut self, idx: usize) -> Result<Value<T>>

where T: Default,

Take the value at the specified index from this field, replacing it with an NA.

fn drain(&mut self) -> DrainIterator<'_, Self::DType>

where Self: Sized,

Returns a draining iterator of the vaules in this DataIndexMut.

impl<T: Debug> Debug for FieldData<T>

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

Formats the value using the given formatter.

impl<T> Default for FieldData<T>

fn default() -> FieldData<T>

Returns the “default value” for a type.

impl<T: Eq> Eq for FieldData<T>

impl<T> From<FieldData<T>> for DataRef<T>

fn from(orig: FieldData<T>) -> DataRef<T>

Converts to this type from the input type.

impl<T> From<FieldData<T>> for Framed<T, DataRef<T>>

fn from(orig: FieldData<T>) -> Framed<T, DataRef<T>>

Converts to this type from the input type.

impl<T> From<Vec<T>> for FieldData<T>

fn from(other: Vec<T>) -> FieldData<T>

Converts to this type from the input type.

impl<T> FromIterator<T> for FieldData<T>

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

Creates a value from an iterator.

impl<'a, T> FromIterator<Value<&'a T>> for FieldData<T>

where T: 'a + Debug + Default + Clone,

fn from_iter<I: IntoIterator<Item = Value<&'a T>>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> FromIterator<Value<T>> for FieldData<T>

where T: Debug + Default,

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

Creates a value from an iterator.

impl<T: Hash> Hash for FieldData<T>

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<Label, T> IntoStore<Label> for FieldData<T>

where Label: Debug, T: Default + Debug,

type Output = DataStore<<DataStore<Nil> as PushFrontFromValueIter<Label, T>>::OutputFields>

The reulting DataStore object.

fn into_store(self) -> Self::Output

Wraps this field data in a DataStore and returns it.

impl<T: PartialEq> PartialEq for FieldData<T>

fn eq(&self, other: &FieldData<T>) -> 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<T> SelfValued for FieldData<T>

impl<T> Serialize for FieldData<T>

where T: Serialize,

Available on crate feature serialize only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for FieldData<T>

impl<T> Typed for FieldData<T>

type DType = T

Associated data type with this type.