Enum StructRef

pub enum StructRef<'a> {
    Indexed {
        arr: &'a StructArray,
        idx: usize,
    },
    ValueRef {
        val: &'a StructValue,
    },
}

Variants

Indexed

Fields

arr: &'a StructArray

idx: usize

ValueRef

Fields

val: &'a StructValue

Implementations

impl<'a> StructRef<'a>

pub fn iter_fields_ref(self) -> impl ExactSizeIterator<Item = DatumRef<'a>> + 'a

Iterates over the fields of the struct.

Prefer using the macro iter_fields_ref! if possible to avoid the cost of enum dispatching.

pub fn field_at(&self, i: usize) -> DatumRef<'a>

Get the field at the given index.

Panics if the index is out of bounds.

pub unsafe fn field_at_unchecked(&self, i: usize) -> DatumRef<'a>

Get the field at the given index.

Safety

The caller must ensure that the index is within bounds.

pub fn memcmp_serialize( self, serializer: &mut Serializer<impl BufMut>, ) -> Result<()>

pub fn hash_scalar_inner<H: Hasher>(self, state: &mut H)

pub fn estimate_serialize_size_inner(self) -> usize

Trait Implementations

impl<'a> Clone for StructRef<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructRef<'_>

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

Formats the value using the given formatter.

impl<'scalar> From<StructRef<'scalar>> for ScalarRefImpl<'scalar>

fn from(val: StructRef<'scalar>) -> Self

Converts to this type from the input type.

impl Ord for StructRef<'_>

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl PartialEq for StructRef<'_>

fn eq(&self, other: &Self) -> 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 PartialOrd for StructRef<'_>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Row for StructRef<'_>

A struct value can be treated as a row.

fn datum_at(&self, index: usize) -> DatumRef<'_>

Returns the DatumRef at the given index.

unsafe fn datum_at_unchecked(&self, index: usize) -> DatumRef<'_>

Returns the DatumRef at the given index without bounds checking.

fn len(&self) -> usize

Returns the number of datum in the row.

fn iter(&self) -> impl Iterator<Item = DatumRef<'_>>

Returns an iterator over the datums in the row, in DatumRef form.

fn is_empty(&self) -> bool

Returns true if the row contains no datum.

fn to_owned_row(&self) -> OwnedRow

Converts the row into an OwnedRow.

fn into_owned_row(self) -> OwnedRow

Consumes self and converts it into an OwnedRow.

fn value_serialize_into(&self, buf: impl BufMut)

Serializes the row with value encoding, into the given buf.

fn value_serialize(&self) -> Vec<u8>

Serializes the row with value encoding and returns the bytes.

fn value_serialize_bytes(&self) -> Bytes

Serializes the row with value encoding and returns the bytes.

fn value_estimate_size(&self) -> usize

fn memcmp_serialize_into(&self, serde: &OrderedRowSerde, buf: impl BufMut)

Serializes the row with memcomparable encoding, into the given buf. As each datum may have different order type, a serde should be provided.

fn memcmp_serialize(&self, serde: &OrderedRowSerde) -> Vec<u8>

Serializes the row with memcomparable encoding and return the bytes. As each datum may have different order type, a serde should be provided.

fn hash_datums_into<H: Hasher>(&self, state: &mut H)

Hash the datums of this row into the given hasher.

fn hash<H: BuildHasher>(&self, hash_builder: H) -> HashCode<H>

Returns the hash code of the row.

fn eq(this: &Self, other: impl Row) -> bool

Determines whether the datums of this row are equal to those of another.

impl<'a> ScalarRef<'a> for StructRef<'a>

Implement Scalar for StructValue.

type ScalarType = StructValue

ScalarType is the owned type of current ScalarRef.

fn to_owned_scalar(&self) -> StructValue

Convert ScalarRef to an owned scalar.

fn hash_scalar<H: Hasher>(&self, state: &mut H)

A wrapped hash function to get the hash value for this scaler.

impl SelfAsScalarRef for StructRef<'_>

fn as_scalar_ref(&self) -> Self

impl ToBinary for StructRef<'_>

fn to_binary_with_type(&self, ty: &DataType) -> Result<Bytes, ToBinaryError>

impl ToText for StructRef<'_>

fn write<W: Write>(&self, f: &mut W) -> Result

Write the text to the writer regardless of its data type

fn write_with_type<W: Write>(&self, ty: &DataType, f: &mut W) -> Result

Write the text to the writer according to its data type

fn to_text_with_type(&self, ty: &DataType) -> String

Convert to text according to its data type

fn to_text(&self) -> String

to_text is a special version of to_text_with_type, it convert the scalar to default type text. E.g. for Int64, it will convert to text as a Int64 type. We should prefer to use to_text_with_type because it’s more clear and readable.

impl<'scalar> TryFrom<ScalarRefImpl<'scalar>> for StructRef<'scalar>

type Error = ArrayError

The type returned in the event of a conversion error.

fn try_from(val: ScalarRefImpl<'scalar>) -> ArrayResult<Self>

Performs the conversion.

impl<'a> Copy for StructRef<'a>

impl Eq for StructRef<'_>