Enum repr::scalar::Datum

pub enum Datum<'a> {
    False,
    True,
    Int16(i16),
    Int32(i32),
    Int64(i64),
    Float32(OrderedFloat<f32>),
    Float64(OrderedFloat<f64>),
    Date(NaiveDate),
    Time(NaiveTime),
    Timestamp(NaiveDateTime),
    TimestampTz(DateTime<Utc>),
    Interval(Interval),
    Bytes(&'a [u8]),
    String(&'a str),
    Array(Array<'a>),
    List(DatumList<'a>),
    Map(DatumMap<'a>),
    Numeric(OrderedDecimal<Numeric>),
    JsonNull,
    Uuid(Uuid),
    Dummy,
    Null,
}

A single value.

Note that Datum must always derive Eq to enforce equality with repr::Row.

Variants

False

The false boolean value.

True

The true boolean value.

Int16(i16)

Tuple Fields

0: i16

A 16-bit signed integer.

Int32(i32)

Tuple Fields

0: i32

A 32-bit signed integer.

Int64(i64)

Tuple Fields

0: i64

A 64-bit signed integer.

Float32(OrderedFloat<f32>)

Tuple Fields

0: OrderedFloat<f32>

A 32-bit floating point number.

Float64(OrderedFloat<f64>)

Tuple Fields

0: OrderedFloat<f64>

A 64-bit floating point number.

Date(NaiveDate)

Tuple Fields

0: NaiveDate

A date.

Time(NaiveTime)

Tuple Fields

0: NaiveTime

A time.

Timestamp(NaiveDateTime)

Tuple Fields

0: NaiveDateTime

A date and time, without a timezone.

TimestampTz(DateTime<Utc>)

Tuple Fields

0: DateTime<Utc>

A date and time, with a timezone.

Interval(Interval)

Tuple Fields

0: Interval

A span of time.

Bytes(&'a [u8])

Tuple Fields

0: &'a [u8]

A sequence of untyped bytes.

String(&'a str)

Tuple Fields

0: &'a str

A sequence of Unicode codepoints encoded as UTF-8.

Array(Array<'a>)

Tuple Fields

0: Array<'a>

Unlike Datum::List, arrays are like tensors and are not permitted to be ragged.

List(DatumList<'a>)

Tuple Fields

0: DatumList<'a>

A sequence of Datums.

Unlike Datum::Array, lists are permitted to be ragged.

Map(DatumMap<'a>)

Tuple Fields

0: DatumMap<'a>

A mapping from string keys to Datums.

Numeric(OrderedDecimal<Numeric>)

Tuple Fields

0: OrderedDecimal<Numeric>

An exact decimal number, possibly with a fractional component, with up to 39 digits of precision.

JsonNull

An unknown value within a JSON-typed Datum.

This variant is distinct from Datum::Null as a null datum is distinct from a non-null datum that contains the JSON value null.

Uuid(Uuid)

Tuple Fields

0: Uuid

A universally unique identifier.

Dummy

A placeholder value.

Dummy values are never meant to be observed. Many operations on Datum panic if called on this variant.

Dummies are useful as placeholders in e.g. a Vec<Datum>, where it is known that a certain element of the vector is never observed and therefore needn’t be computed, but where some Datum must still be provided to maintain the shape of the vector. While any valid datum could be used for this purpose, having a dedicated variant makes it obvious when these optimizations have gone awry. If we used e.g. Datum::Null, an unexpected Datum::Null could indicate any number of problems: bad user data, bad function metadata, or a bad optimization.

Null

An unknown value.

Implementations

impl<'a> Datum<'a>

pub fn is_null(&self) -> bool

Reports whether this datum is null (i.e., is Datum::Null).

pub fn unwrap_bool(&self) -> bool

Unwraps the boolean value within this datum.

Panics

Panics if the datum is not Datum::False or Datum::True.

pub fn unwrap_int16(&self) -> i16

Unwraps the 16-bit integer value within this datum.

Panics

Panics if the datum is not Datum::Int16.

pub fn unwrap_int32(&self) -> i32

Unwraps the 32-bit integer value within this datum.

Panics

Panics if the datum is not Datum::Int32.

pub fn unwrap_int64(&self) -> i64

Unwraps the 64-bit integer value within this datum.

Panics

Panics if the datum is not Datum::Int64.

pub fn unwrap_ordered_float32(&self) -> OrderedFloat<f32>

pub fn unwrap_ordered_float64(&self) -> OrderedFloat<f64>

pub fn unwrap_float32(&self) -> f32

Unwraps the 32-bit floating-point value within this datum.

Panics

Panics if the datum is not Datum::Float32.

pub fn unwrap_float64(&self) -> f64

Unwraps the 64-bit floating-point value within this datum.

Panics

Panics if the datum is not Datum::Float64.

pub fn unwrap_date(&self) -> NaiveDate

Unwraps the date value within this datum.

Panics

Panics if the datum is not Datum::Date.

pub fn unwrap_time(&self) -> NaiveTime

Unwraps the time value within this datum.

Panics

Panics if the datum is not Datum::Time.

pub fn unwrap_timestamp(&self) -> NaiveDateTime

Unwraps the timestamp value within this datum.

Panics

Panics if the datum is not Datum::Timestamp.

pub fn unwrap_timestamptz(&self) -> DateTime<Utc>

Unwraps the timestamptz value within this datum.

Panics

Panics if the datum is not Datum::TimestampTz.

pub fn unwrap_interval(&self) -> Interval

Unwraps the interval value within this datum.

Panics

Panics if the datum is not Datum::Interval.

pub fn unwrap_str(&self) -> &'a str

Unwraps the string value within this datum.

Panics

Panics if the datum is not Datum::String.

pub fn unwrap_bytes(&self) -> &'a [u8]

Unwraps the bytes value within this datum.

Panics

Panics if the datum is not Datum::Bytes.

pub fn unwrap_uuid(&self) -> Uuid

Unwraps the uuid value within this datum.

Panics

Panics if the datum is not Datum::Uuid.

pub fn unwrap_array(&self) -> Array<'a>

Unwraps the array value within this datum.

Panics

Panics if the datum is not Datum::Array.

pub fn unwrap_list(&self) -> DatumList<'a>

Unwraps the list value within this datum.

Panics

Panics if the datum is not Datum::List.

pub fn unwrap_map(&self) -> DatumMap<'a>

Unwraps the map value within this datum.

Panics

Panics if the datum is not Datum::Map.

pub fn unwrap_numeric(&self) -> OrderedDecimal<Numeric>

Unwraps the numeric value within this datum.

Panics

Panics if the datum is not Datum::Numeric.

pub fn is_instance_of(self, column_type: &ColumnType) -> bool

Reports whether this datum is an instance of the specified column type.

impl Datum<'static>

pub fn empty_array() -> Datum<'static>

pub fn empty_list() -> Datum<'static>

Trait Implementations

impl<'a> Clone for Datum<'a>

fn clone(&self) -> Datum<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, E> DatumType<'a, E> for Datum<'a>

fn nullable() -> bool

Whether this Rust type can represent NULL values

fn try_from_result(
    res: Result<Datum<'a>, E>
) -> Result<Self, Result<Datum<'a>, E>>

Try to convert a Result whose Ok variant is a Datum into this native Rust type (Self). If it fails the error variant will contain the original result.

fn into_result(self, _temp_storage: &'a RowArena) -> Result<Datum<'a>, E>

Convert this Rust type into a Result containing a Datum, or an error

impl<'a> Debug for Datum<'a>

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

Formats the value using the given formatter.

impl Display for Datum<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for Datum<'a>

fn from(b: &'a [u8]) -> Datum<'a>

Performs the conversion.

impl<'a> From<&'a str> for Datum<'a>

fn from(s: &'a str) -> Datum<'a>

Performs the conversion.

impl<'a> From<DateTime<Utc>> for Datum<'a>

fn from(dt: DateTime<Utc>) -> Datum<'a>

Performs the conversion.

impl<'a> From<Datum<'a>> for ProtoDatum

fn from(x: Datum<'a>) -> Self

Performs the conversion.

impl<'a> From<Decimal<NUMERIC_DATUM_WIDTH>> for Datum<'a>

fn from(n: Numeric) -> Datum<'a>

Performs the conversion.

impl<'a> From<Duration> for Datum<'a>

fn from(duration: Duration) -> Datum<'a>

Performs the conversion.

impl<'a> From<Interval> for Datum<'a>

fn from(other: Interval) -> Datum<'a>

Performs the conversion.

impl<'a> From<NaiveDate> for Datum<'a>

fn from(d: NaiveDate) -> Datum<'a>

Performs the conversion.

impl<'a> From<NaiveDateTime> for Datum<'a>

fn from(dt: NaiveDateTime) -> Datum<'a>

Performs the conversion.

impl<'a> From<NaiveTime> for Datum<'a>

fn from(t: NaiveTime) -> Datum<'a>

Performs the conversion.

impl<'a, T> From<Option<T>> for Datum<'a> where
    Datum<'a>: From<T>, 

fn from(o: Option<T>) -> Datum<'a>

Performs the conversion.

impl<'a> From<OrderedFloat<f32>> for Datum<'a>

fn from(f: OrderedFloat<f32>) -> Datum<'a>

Performs the conversion.

impl<'a> From<OrderedFloat<f64>> for Datum<'a>

fn from(f: OrderedFloat<f64>) -> Datum<'a>

Performs the conversion.

impl<'a> From<Uuid> for Datum<'a>

fn from(uuid: Uuid) -> Datum<'a>

Performs the conversion.

impl<'a> From<bool> for Datum<'a>

fn from(b: bool) -> Datum<'a>

Performs the conversion.

impl<'a> From<f32> for Datum<'a>

fn from(f: f32) -> Datum<'a>

Performs the conversion.

impl<'a> From<f64> for Datum<'a>

fn from(f: f64) -> Datum<'a>

Performs the conversion.

impl<'a> From<i128> for Datum<'a>

fn from(d: i128) -> Datum<'a>

Performs the conversion.

impl<'a> From<i16> for Datum<'a>

fn from(i: i16) -> Datum<'a>

Performs the conversion.

impl<'a> From<i32> for Datum<'a>

fn from(i: i32) -> Datum<'a>

Performs the conversion.

impl<'a> From<i64> for Datum<'a>

fn from(i: i64) -> Datum<'a>

Performs the conversion.

impl<'a> Hash for Datum<'a>

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, 

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Datum<'a>

fn cmp(&self, other: &Datum<'a>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'a> PartialEq<Datum<'a>> for Datum<'a>

fn eq(&self, other: &Datum<'a>) -> bool

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

fn ne(&self, other: &Datum<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Datum<'a>> for Datum<'a>

fn partial_cmp(&self, other: &Datum<'a>) -> 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 TryFrom<Datum<'_>> for bool

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for Option<bool>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(datum: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for i64

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for Option<i64>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for NaiveDateTime

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for DateTime<Utc>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for f32

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for Option<f32>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for f64

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for Option<f64>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for i16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for Option<i16>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for i32

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Datum<'_>> for Option<i32>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(from: Datum<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Copy for Datum<'a>

impl<'a> Eq for Datum<'a>

impl<'a> StructuralEq for Datum<'a>

impl<'a> StructuralPartialEq for Datum<'a>