Row

Struct Row 

Source
pub struct Row { /* private fields */ }
Expand description

A row from a query result.

Implements the Arc<Bytes> pattern from ADR-004 for reduced memory allocation. The row holds a shared reference to the raw packet buffer and column slice information, deferring parsing and allocation until values are accessed.

§Memory Model

Row {
    buffer: Arc<Bytes> ──────────► [raw packet data...]
    slices: Arc<[ColumnSlice]> ──► [{offset, length, is_null}, ...]
    metadata: Arc<ColMetaData> ──► [Column definitions...]
}

Multiple Row instances from the same result set share the metadata. The buffer and slices are unique per row but use Arc for cheap cloning.

§Access Patterns

  • Zero-copy: get_bytes(), get_str() (when UTF-8 valid)
  • Allocating: get_string(), get::<String>()
  • Type-converting: get::<T>() uses FromSql trait

Implementations§

Source§

impl Row

Source

pub fn new( buffer: Arc<Bytes>, slices: Arc<[ColumnSlice]>, metadata: Arc<ColMetaData>, ) -> Self

Create a new row with the Arc<Bytes> pattern.

This is the primary constructor for the reduced-copy pattern.

Source

pub fn get_bytes(&self, index: usize) -> Option<&[u8]>

Returns borrowed slice into buffer (zero additional allocation).

This is the most efficient access method when you need raw bytes.

Source

pub fn get_str(&self, index: usize) -> Option<Cow<'_, str>>

Returns Cow - borrowed if valid UTF-8, owned if conversion needed.

For UTF-8 data, this returns a borrowed reference (zero allocation). For UTF-16 data (NVARCHAR), this allocates a new String.

Source

pub fn get_string(&self, index: usize) -> Option<String>

Allocates new String (explicit allocation).

Use this when you need an owned String.

Source

pub fn get<T: FromSql>(&self, index: usize) -> Result<T, TypeError>

Get a value by column index with type conversion.

Uses the FromSql trait to convert the raw value to the requested type.

Source

pub fn get_by_name<T: FromSql>(&self, name: &str) -> Result<T, TypeError>

Get a value by column name with type conversion.

Source

pub fn try_get<T: FromSql>(&self, index: usize) -> Option<T>

Try to get a value by column index, returning None if NULL or not found.

Source

pub fn try_get_by_name<T: FromSql>(&self, name: &str) -> Option<T>

Try to get a value by column name, returning None if NULL or not found.

Source

pub fn get_raw(&self, index: usize) -> Option<SqlValue>

Get the raw SQL value by index.

Note: This may allocate if values haven’t been cached.

Source

pub fn get_raw_by_name(&self, name: &str) -> Option<SqlValue>

Get the raw SQL value by column name.

Source

pub fn len(&self) -> usize

Get the number of columns in the row.

Source

pub fn is_empty(&self) -> bool

Check if the row is empty.

Source

pub fn columns(&self) -> &[Column]

Get the column metadata.

Source

pub fn metadata(&self) -> &Arc<ColMetaData>

Get the shared column metadata.

Source

pub fn is_null(&self, index: usize) -> bool

Check if a column value is NULL.

Source

pub fn is_null_by_name(&self, name: &str) -> bool

Check if a column value is NULL by name.

Trait Implementations§

Source§

impl Clone for Row

Source§

fn clone(&self) -> Row

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Row

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> IntoIterator for &'a Row

Source§

type Item = SqlValue

The type of the elements being iterated over.
Source§

type IntoIter = RowIter<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl Freeze for Row

§

impl RefUnwindSafe for Row

§

impl Send for Row

§

impl Sync for Row

§

impl Unpin for Row

§

impl UnwindSafe for Row

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more