Struct holochain_state::query::prelude::Row

pub struct Row<'stmt> { /* private fields */ }

A single result row of a query.

Implementations

impl<'stmt> Row<'stmt>

pub fn get_unwrap<I, T>(&self, idx: I) -> T

where I: RowIndex, T: FromSql,

Get the value of a particular column of the result row.

Failure

Panics if calling row.get(idx) would return an error, including:

• If the underlying SQLite column type is not a valid type as a source for T
• If the underlying SQLite integral value is outside the range representable by T
• If idx is outside the range of columns in the returned query

pub fn get<I, T>(&self, idx: I) -> Result<T, Error>

where I: RowIndex, T: FromSql,

Get the value of a particular column of the result row.

Failure

Returns an Error::InvalidColumnType if the underlying SQLite column type is not a valid type as a source for T.

Returns an Error::InvalidColumnIndex if idx is outside the valid column range for this row.

Returns an Error::InvalidColumnName if idx is not a valid column name for this row.

If the result type is i128 (which requires the i128_blob feature to be enabled), and the underlying SQLite column is a blob whose size is not 16 bytes, Error::InvalidColumnType will also be returned.

pub fn get_ref<I>(&self, idx: I) -> Result<ValueRef<'_>, Error>

where I: RowIndex,

Get the value of a particular column of the result row as a ValueRef, allowing data to be read out of a row without copying.

This ValueRef is valid only as long as this Row, which is enforced by it’s lifetime. This means that while this method is completely safe, it can be somewhat difficult to use, and most callers will be better served by get or get_unwrap.

Failure

Returns an Error::InvalidColumnIndex if idx is outside the valid column range for this row.

Returns an Error::InvalidColumnName if idx is not a valid column name for this row.

pub fn get_ref_unwrap<I>(&self, idx: I) -> ValueRef<'_>

where I: RowIndex,

Get the value of a particular column of the result row as a ValueRef, allowing data to be read out of a row without copying.

This ValueRef is valid only as long as this Row, which is enforced by it’s lifetime. This means that while this method is completely safe, it can be difficult to use, and most callers will be better served by get or get_unwrap.

Failure

Panics if calling row.get_ref(idx) would return an error, including:

• If idx is outside the range of columns in the returned query.
• If idx is not a valid column name for this row.

Trait Implementations

impl<'stmt> AsRef<Statement<'stmt>> for Row<'stmt>

fn as_ref(&self) -> &Statement<'stmt>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'stmt> Debug for Row<'stmt>

Debug Row like an ordered Map<Result<&str>, Result<(Type, ValueRef)>> with column name as key except that for Type::Blob only its size is printed (not its content).

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

Formats the value using the given formatter.