risingwave_common::row

Trait Row

pub trait Row:
    Sized
    + Debug
    + PartialEq
    + Eq {
Show 16 methods    // Required methods
    fn datum_at(&self, index: usize) -> DatumRef<'_>;
    unsafe fn datum_at_unchecked(&self, index: usize) -> DatumRef<'_>;
    fn len(&self) -> usize;
    fn iter(&self) -> impl Iterator<Item = DatumRef<'_>>;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn to_owned_row(&self) -> OwnedRow { ... }
    fn into_owned_row(self) -> OwnedRow { ... }
    fn value_serialize_into(&self, buf: impl BufMut) { ... }
    fn value_serialize(&self) -> Vec<u8> ⓘ { ... }
    fn value_serialize_bytes(&self) -> Bytes { ... }
    fn value_estimate_size(&self) -> usize { ... }
    fn memcmp_serialize_into(&self, serde: &OrderedRowSerde, buf: impl BufMut) { ... }
    fn memcmp_serialize(&self, serde: &OrderedRowSerde) -> Vec<u8> ⓘ { ... }
    fn hash_datums_into<H: Hasher>(&self, state: &mut H) { ... }
    fn hash<H: BuildHasher>(&self, hash_builder: H) -> HashCode<H> { ... }
    fn eq(this: &Self, other: impl Row) -> bool { ... }
}

Expand description

The trait for abstracting over a Row-like type.

Required Methods§

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.

§Safety

Calling this method with an out-of-bounds index is undefined behavior.

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.

Provided Methods§

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.

Prefer into_owned_row if the row is already owned.

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.

Implementors should delegate std::hash::Hash::hash to this method.

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.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

impl<D: ToDatumRef> Row for &[D]

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

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

fn len(&self) -> usize

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

impl<D: ToDatumRef, const N: usize> Row for [D; N]

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

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

fn len(&self) -> usize

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

impl<R1: Row, R2: Row> Row for Either<R1, R2>

Implements Row for an either::Either of two different types of rows.

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

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

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

fn to_owned_row(&self) -> OwnedRow

fn into_owned_row(self) -> OwnedRow

fn value_serialize_into(&self, buf: impl BufMut)

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

fn value_serialize_bytes(&self) -> Bytes

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

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

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

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

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

impl<R: Row + Clone> Row for Cow<'_, R>

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

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

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

fn to_owned_row(&self) -> OwnedRow

fn value_serialize_into(&self, buf: impl BufMut)

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

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

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

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

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

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

fn into_owned_row(self) -> OwnedRow

impl<R: Row> Row for Option<R>

Implements Row for an optional row.

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

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

fn len(&self) -> usize

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

fn to_owned_row(&self) -> OwnedRow

fn into_owned_row(self) -> OwnedRow

fn value_serialize_into(&self, buf: impl BufMut)

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

impl<R: Row> Row for &R

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

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

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

fn to_owned_row(&self) -> OwnedRow

fn value_serialize_into(&self, buf: impl BufMut)

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

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

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

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

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

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

impl<R: Row> Row for Box<R>

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

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

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

fn to_owned_row(&self) -> OwnedRow

fn value_serialize_into(&self, buf: impl BufMut)

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

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

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

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

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

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

fn into_owned_row(self) -> OwnedRow

Implementors§

impl Row for StructRef<'_>

A struct value can be treated as a row.

impl Row for RowRef<'_>

impl Row for ListRef<'_>

impl Row for Empty

impl Row for OwnedRow

impl<D: ToDatumRef + Default, const N: usize> Row for ArrayVec<[D; N]>

impl<D: ToDatumRef> Row for Once<D>

impl<D: ToDatumRef> Row for RepeatN<D>

impl<R1: Row, R2: Row> Row for Chain<R1, R2>

impl<R: Row> Row for DefaultOrdered<R>

impl<R: Row> Row for Project<'_, R>

impl<R: Row> Row for Slice<R>