Skip to main content

Row

Struct Row 

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

A row of data from a query.

Data can be accessed either by copying through get or try_get methods, or moving by value using the IntoIterator implementation.

// by-reference
let row = client
    .query("SELECT @P1 AS col1", &[&"test"])
    .await?
    .into_row()
    .await?
    .unwrap();

assert_eq!(Some("test"), row.get("col1"));

// ...or by-value
let row = client
    .query("SELECT @P1 AS col1", &[&"test"])
    .await?
    .into_row()
    .await?
    .unwrap();

for val in row.into_iter() {
    assert_eq!(
        Some(String::from("test")),
        String::from_sql_owned(val)?
    )
}

Implementations§

Source§

impl Row

Source

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

Columns defining the row data. Columns listed here are in the same order as the resulting data.

§Example
let row = client
    .query("SELECT 1 AS foo, 2 AS bar", &[])
    .await?
    .into_row()
    .await?
    .unwrap();

assert_eq!("foo", row.columns()[0].name());
assert_eq!("bar", row.columns()[1].name());
Source

pub fn cells(&self) -> impl Iterator<Item = (&Column, &ColumnData<'static>)>

Return an iterator over row column-value pairs.

Source

pub fn result_index(&self) -> usize

The result set number, starting from zero and increasing if the stream has results from more than one query.

Source

pub fn len(&self) -> usize

Returns the number of columns in the row.

§Example
let row = client
    .query("SELECT 1, 2", &[])
    .await?
    .into_row()
    .await?
    .unwrap();

assert_eq!(2, row.len());
Source

pub fn get<'a, R, I>(&'a self, idx: I) -> Option<R>
where R: FromSql<'a>, I: QueryIdx,

Retrieve a column value for a given column index, which can either be the zero-indexed position or the name of the column.

§Example
let row = client
    .query("SELECT @P1 AS col1", &[&1i32])
    .await?
    .into_row()
    .await?
    .unwrap();

assert_eq!(Some(1i32), row.get(0));
assert_eq!(Some(1i32), row.get("col1"));
§Panics
  • The requested type conversion (SQL->Rust) is not possible.
  • The given index is out of bounds (column does not exist).

Use try_get for a non-panicking version of the function.

Source

pub fn try_get<'a, R, I>(&'a self, idx: I) -> Result<Option<R>>
where R: FromSql<'a>, I: QueryIdx,

Retrieve a column’s value for a given column index.

Source

pub fn get_column_data<I>(&self, idx: I) -> Result<&ColumnData<'static>>
where I: QueryIdx,

Retrieve a column’s data for a given column index.

Source

pub fn into_token_row(self) -> TokenRow<'static>

Consumes the row, returning the underlying TokenRow holding the raw column data as received from the server.

This is useful when direct access to the raw ColumnData values is needed instead of converting them through get or try_get.

Trait Implementations§

Source§

impl Debug for Row

Source§

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

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

impl<'de> Deserialize<'de> for Row

Available on crate feature serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl IntoIterator for Row

Source§

type Item = ColumnData<'static>

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<<Row as IntoIterator>::Item>

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

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl Serialize for Row

Available on crate feature serde only.
Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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 UnsafeUnpin for Row

§

impl UnwindSafe for Row

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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