pub struct SpiHeapTupleData { /* private fields */ }Expand description
Represents the set of pg_sys::Datums in a pg_sys::HeapTuple
Implementations§
Source§impl SpiHeapTupleData
impl SpiHeapTupleData
Sourcepub unsafe fn new(
tupdesc: *mut TupleDescData,
htup: *mut HeapTupleData,
) -> Result<Option<SpiHeapTupleData>, Error>
pub unsafe fn new( tupdesc: *mut TupleDescData, htup: *mut HeapTupleData, ) -> Result<Option<SpiHeapTupleData>, Error>
Create a new SpiHeapTupleData from its constituent parts
§Safety
This is unsafe as it cannot ensure that the provided tupdesc and htup arguments
are valid, palloc’d pointers.
Sourcepub fn get<T>(&self, ordinal: usize) -> Result<Option<T>, Error>
pub fn get<T>(&self, ordinal: usize) -> Result<Option<T>, Error>
Get a typed value from this HeapTuple by its ordinal position.
The ordinal position is 1-based
§Errors
Returns a Error::DatumError if the desired Rust type is incompatible
with the underlying Datum
Sourcepub fn get_by_name<T, S>(&self, name: S) -> Result<Option<T>, Error>
pub fn get_by_name<T, S>(&self, name: S) -> Result<Option<T>, Error>
Get a typed value from this HeapTuple by its name in the resultset.
§Errors
Returns a Error::DatumError if the desired Rust type is incompatible
with the underlying Datum
Sourcepub fn get_datum_by_ordinal(
&self,
ordinal: usize,
) -> Result<&SpiHeapTupleDataEntry, Error>
pub fn get_datum_by_ordinal( &self, ordinal: usize, ) -> Result<&SpiHeapTupleDataEntry, Error>
Get a raw Datum from this HeapTuple by its ordinal position.
The ordinal position is 1-based.
§Errors
If the specified ordinal is out of bounds a [Error::SpiError(SpiError::NoAttribute)] is returned
Sourcepub fn get_datum_by_name<S>(
&self,
name: S,
) -> Result<&SpiHeapTupleDataEntry, Error>
pub fn get_datum_by_name<S>( &self, name: S, ) -> Result<&SpiHeapTupleDataEntry, Error>
Sourcepub fn set_by_ordinal<T>(
&mut self,
ordinal: usize,
datum: T,
) -> Result<(), Error>where
T: IntoDatum,
pub fn set_by_ordinal<T>(
&mut self,
ordinal: usize,
datum: T,
) -> Result<(), Error>where
T: IntoDatum,
Set a datum value for the specified ordinal position
§Errors
If the specified ordinal is out of bounds a SpiErrorCodes::NoAttribute is returned
Sourcepub fn set_by_name<T>(&mut self, name: &str, datum: T) -> Result<(), Error>where
T: IntoDatum,
pub fn set_by_name<T>(&mut self, name: &str, datum: T) -> Result<(), Error>where
T: IntoDatum,
pub fn columns(&self) -> usize
Trait Implementations§
Source§impl Index<&str> for SpiHeapTupleData
Provide named indexing into a SpiHeapTupleData.
impl Index<&str> for SpiHeapTupleData
Provide named indexing into a SpiHeapTupleData.
If the field name doesn’t exist, it will panic
Source§impl Index<usize> for SpiHeapTupleData
Provide ordinal indexing into a SpiHeapTupleData.
impl Index<usize> for SpiHeapTupleData
Provide ordinal indexing into a SpiHeapTupleData.
If the index is out of bounds, it will panic
Auto Trait Implementations§
impl Freeze for SpiHeapTupleData
impl RefUnwindSafe for SpiHeapTupleData
impl !Send for SpiHeapTupleData
impl !Sync for SpiHeapTupleData
impl Unpin for SpiHeapTupleData
impl UnwindSafe for SpiHeapTupleData
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.