Struct pgx::spi::SpiHeapTupleData

pub struct SpiHeapTupleData { /* fields omitted */ }

Represents the set of pg_sys::Datums in a pg_sys::HeapTuple

Implementations

impl SpiHeapTupleData

pub fn new(tupdesc: TupleDesc, htup: *mut HeapTupleData) -> Self

Create a new SpiHeapTupleData from its constituent parts

pub fn get_datum<T: FromDatum>(&self, ordinal: usize) -> Option<T>

👎 Deprecated since 0.1.6:

Please use the by_ordinal function instead

Get a typed Datum value from this HeapTuple by its ordinal position.

The ordinal position is 1-based

pub fn by_ordinal(
    &self,
    ordinal: usize
) -> Result<&SpiHeapTupleDataEntry, SpiError>

Get a typed Datum value from this HeapTuple by its ordinal position.

The ordinal position is 1-based.

If the specified ordinal is out of bounds a Err(SpiError::Noattribute) is returned

pub fn by_name(&self, name: &str) -> Result<&SpiHeapTupleDataEntry, SpiError>

Get a typed Datum value from this HeapTuple by its field name.

If the specified name does not exist a Err(SpiError::Noattribute) is returned

pub fn by_ordinal_mut(
    &mut self,
    ordinal: usize
) -> Result<&mut SpiHeapTupleDataEntry, SpiError>

Get a mutable typed Datum value from this HeapTuple by its ordinal position.

The ordinal position is 1-based.

If the specified ordinal is out of bounds a Err(SpiError::Noattribute) is returned

pub fn by_name_mut(
    &mut self,
    name: &str
) -> Result<&mut SpiHeapTupleDataEntry, SpiError>

Get a mutable typed Datum value from this HeapTuple by its field name.

If the specified name does not exist a Err(SpiError::Noattribute) is returned

pub fn set_by_ordinal<T: IntoDatum + FromDatum>(
    &mut self,
    ordinal: usize,
    datum: T
) -> Result<(), SpiError>

Set a datum value for the specified ordinal position

If the specified ordinal is out of bounds a Err(SpiError::Noattribute) is returned

pub fn set_by_name<T: IntoDatum + FromDatum>(
    &mut self,
    name: &str,
    datum: T
) -> Result<(), SpiError>

Set a datum value for the specified field name

If the specified name does not exist a Err(SpiError::Noattribute) is returned

Trait Implementations

impl Index<&'_ str> for SpiHeapTupleData

Provide named indexing into a SpiHeapTupleData.

If the field name doesn't exist, it will panic

type Output = SpiHeapTupleDataEntry

The returned type after indexing.

pub fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for SpiHeapTupleData

Provide ordinal indexing into a SpiHeapTupleData.

If the index is out of bounds, it will panic

type Output = SpiHeapTupleDataEntry

The returned type after indexing.

pub fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<&'_ str> for SpiHeapTupleData

Provide mutable named indexing into a SpiHeapTupleData.

If the field name doesn't exist, it will panic

pub fn index_mut(&mut self, index: &str) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for SpiHeapTupleData

Provide mutable ordinal indexing into a SpiHeapTupleData.

If the index is out of bounds, it will panic

pub fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.