Struct Response 

pub struct Response<E: EntityKind>(pub Vec<Row<E>>);

Response Materialized query result: ordered (Key, Entity) pairs.

Tuple Fields

0: Vec<Row<E>>

Implementations

impl<E: EntityKind> Response<E>

pub const fn count(&self) -> u32

Number of rows in the response, truncated to u32.

pub const fn is_empty(&self) -> bool

True when no rows were returned.

pub fn require_one(&self) -> Result<(), RuntimeError>

Require exactly one row.

pub fn require_some(&self) -> Result<(), RuntimeError>

Require at least one row.

pub fn require_len(&self, expected: u32) -> Result<(), RuntimeError>

Require exactly expected rows.

pub fn one(self) -> Result<Row<E>, RuntimeError>

Require exactly one row and return it.

pub fn one_opt(self) -> Result<Option<Row<E>>, RuntimeError>

Require at most one row and return it.

pub fn into_page(self, limit: usize) -> Page<E>

Convert the response into a page of entities with a has_more indicator.

This consumes at most limit + 1 rows to determine whether more results exist. Ordering is preserved.

NOTE:

• has_more only indicates the existence of additional rows
• Page boundaries are not stable unless the underlying query ordering is stable

pub fn key(&self) -> Option<Key>

First key in the response, if present.

pub fn keys(&self) -> Vec<Key>

Collect all keys in order.

pub fn one_key(self) -> Result<Key, RuntimeError>

Require exactly one row and return its key.

pub fn one_opt_key(self) -> Result<Option<Key>, RuntimeError>

Require at most one row and return its key.

pub fn contains_key(&self, key: &Key) -> bool

pub fn entity(self) -> Option<E>

Consume the response and return the first entity, if any.

pub fn entities(self) -> Vec<E>

Consume the response and collect all entities.

pub fn one_entity(self) -> Result<E, RuntimeError>

Require exactly one entity.

pub fn one_opt_entity(self) -> Result<Option<E>, RuntimeError>

Require at most one entity.

pub fn pk(&self) -> Option<E::PrimaryKey>

First primary key in the response, if present.

pub fn pks(&self) -> Vec<E::PrimaryKey>

Collect all primary keys in order.

pub fn one_pk(self) -> Result<E::PrimaryKey, RuntimeError>

Require exactly one primary key.

pub fn one_opt_pk(self) -> Result<Option<E::PrimaryKey>, RuntimeError>

Require at most one primary key.

pub fn view(self) -> Option<E::ViewType>

Convert the first entity to its view type, if present.

pub fn one_view(self) -> Result<E::ViewType, RuntimeError>

Require exactly one view.

pub fn one_opt_view(self) -> Result<Option<E::ViewType>, RuntimeError>

Require at most one view.

pub fn views(self) -> Vec<E::ViewType>

Convert all entities to their view types.

pub fn first(self) -> Option<Row<E>>

Return the first row in the response, if any.

This does NOT enforce cardinality. Use only when row order is well-defined and uniqueness is irrelevant.

pub fn first_entity(self) -> Option<E>

Return the first entity in the response, if any.

This does NOT enforce cardinality. Use only when row order is well-defined and uniqueness is irrelevant.

pub fn first_pk(self) -> Option<E::PrimaryKey>

Return the first primary key in the response, if any.

This does NOT enforce cardinality.

Trait Implementations

impl<E: Debug + EntityKind> Debug for Response<E>

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

Formats the value using the given formatter.

impl<E: EntityKind> IntoIterator for Response<E>

type Item = (Key, E)

The type of the elements being iterated over.

type IntoIter = IntoIter<<Response<E> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.