Struct spacetimedb_sats::product_value::ProductValue

pub struct ProductValue {
    pub elements: Vec<AlgebraicValue>,
}

A product value is made of a list of “elements” / “fields” / “factors” of other AlgebraicValues.

The type of a product value is a product type.

Fields

elements: Vec<AlgebraicValue>

The values that make up this product value.

Implementations

impl ProductValue

pub fn decode<'a>( ty: &<Self as Value>::Type, bytes: &mut impl BufReader<'a> ) -> Result<Self, DecodeError>

Decode a value from bytes typed at ty.

pub fn decode_smallvec<'a>( ty: &<Self as Value>::Type, bytes: &mut impl BufReader<'a> ) -> Result<SmallVec<[Self; 1]>, DecodeError>

Decode a vector of values from bytes with each value typed at ty.

pub fn encode(&self, bytes: &mut impl BufWriter)

impl ProductValue

pub fn new(elements: &[AlgebraicValue]) -> Self

Returns a product value constructed from the given values in elements.

impl ProductValue

pub fn get_field( &self, col_pos: usize, name: Option<&'static str> ) -> Result<&AlgebraicValue, InvalidFieldError>

Borrow the value at field of self identified by col_pos.

The name is non-functional and is only used for error-messages.

pub fn project( &self, indexes: &[(ColId, Option<&'static str>)] ) -> Result<AlgebraicValue, InvalidFieldError>

This function is used to project fields based on the provided indexes.

It will raise an InvalidFieldError if any of the supplied indexes cannot be found.

The optional parameter name: Option<&'static str> serves a non-functional role and is solely utilized for generating error messages.

Important:

The resulting AlgebraicValue will wrap into a ProductValue when projecting multiple fields, otherwise it will consist of a single AlgebraicValue.

pub fn project_not_empty( &self, cols: &ColList ) -> Result<AlgebraicValue, InvalidFieldError>

This utility function is designed to project fields based on the supplied indexes.

Important:

The resulting AlgebraicValue will wrap into a ProductValue when projecting multiple fields, otherwise it will consist of a single AlgebraicValue.

Parameters:

• cols: A ColList containing the indexes of fields to be projected.

pub fn extract_field<'a, T>( &'a self, col_pos: usize, name: Option<&'static str>, f: impl 'a + Fn(&'a AlgebraicValue) -> Option<T> ) -> Result<T, InvalidFieldError>

Extracts the value at field of self identified by index and then runs it through the function f which possibly returns a T derived from value.

pub fn field_as_bool( &self, index: usize, named: Option<&'static str> ) -> Result<bool, InvalidFieldError>

Interprets the value at field of self identified by index as a bool.

pub fn field_as_u8( &self, index: usize, named: Option<&'static str> ) -> Result<u8, InvalidFieldError>

Interprets the value at field of self identified by index as a u8.

pub fn field_as_u32( &self, index: usize, named: Option<&'static str> ) -> Result<u32, InvalidFieldError>

Interprets the value at field of self identified by index as a u32.

pub fn field_as_u64( &self, index: usize, named: Option<&'static str> ) -> Result<u64, InvalidFieldError>

Interprets the value at field of self identified by index as a u64.

pub fn field_as_i64( &self, index: usize, named: Option<&'static str> ) -> Result<i64, InvalidFieldError>

Interprets the value at field of self identified by index as a i64.

pub fn field_as_i128( &self, index: usize, named: Option<&'static str> ) -> Result<i128, InvalidFieldError>

Interprets the value at field of self identified by index as a i128.

pub fn field_as_u128( &self, index: usize, named: Option<&'static str> ) -> Result<u128, InvalidFieldError>

Interprets the value at field of self identified by index as a u128.

pub fn field_as_str( &self, index: usize, named: Option<&'static str> ) -> Result<&str, InvalidFieldError>

Interprets the value at field of self identified by index as a string slice.

pub fn field_as_bytes( &self, index: usize, named: Option<&'static str> ) -> Result<&[u8], InvalidFieldError>

Interprets the value at field of self identified by index as a byte slice.

pub fn field_as_array( &self, index: usize, named: Option<&'static str> ) -> Result<&ArrayValue, InvalidFieldError>

Interprets the value at field of self identified by index as an ArrayValue.

pub fn field_as_sum( &self, index: usize, named: Option<&'static str> ) -> Result<SumValue, InvalidFieldError>

Interprets the value at field of self identified by index as a SumValue.

Trait Implementations

impl Clone for ProductValue

fn clone(&self) -> ProductValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProductValue

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

Formats the value using the given formatter.

impl From<&AlgebraicValue> for ProductValue

fn from(x: &AlgebraicValue) -> Self

Converts to this type from the input type.

impl From<AlgebraicValue> for ProductValue

fn from(x: AlgebraicValue) -> Self

Converts to this type from the input type.

impl From<ProductValue> for AlgebraicValue

fn from(original: ProductValue) -> AlgebraicValue

Converts to this type from the input type.

impl FromIterator<AlgebraicValue> for ProductValue

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

Creates a value from an iterator.

impl Hash for ProductValue

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<'a> IntoIterator for &'a ProductValue

type Item = &'a AlgebraicValue

The type of the elements being iterated over.

type IntoIter = Iter<'a, AlgebraicValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ProductValue

type Item = AlgebraicValue

The type of the elements being iterated over.

type IntoIter = IntoIter<AlgebraicValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for ProductValue

fn cmp(&self, other: &ProductValue) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ProductValue

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

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

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

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

impl PartialOrd for ProductValue

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

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

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

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

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

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

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

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

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 Serialize for ProductValue

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

Serialize self in the data format of S using the provided serializer.

impl ToDataKey for ProductValue

fn to_data_key(&self) -> DataKey

impl Value for ProductValue

type Type = ProductType

The type of this value.

impl Eq for ProductValue

impl StructuralPartialEq for ProductValue