Struct Response 

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

Response

Materialized query result: ordered (Id, Entity) pairs. IDs are returned for correlation, reporting, and lookup; they are public values and do not imply authorization, ownership, or row existence outside this response payload. When scalar projection evaluation runs, projected_rows() exposes the evaluated projection payload in matching row order.

Tuple Fields

0: Vec<Row<E>>

Implementations

impl<E: EntityKind> Response<E>

pub const fn from_rows(rows: Vec<Row<E>>) -> Self

Construct one entity-row response without projection payload.

pub const fn from_rows_with_projection( rows: Vec<Row<E>>, projected_rows: Option<Vec<ProjectedRow<E>>>, ) -> Self

Construct one entity-row response with optional scalar projection output.

pub fn projected_rows(&self) -> Option<&[ProjectedRow<E>]>

Borrow optional projected scalar rows when projection materialization ran.

pub fn into_projected_rows(self) -> Option<Vec<ProjectedRow<E>>>

Consume and return optional projected scalar rows.

pub const fn count(&self) -> u32

Return the number of rows as a u32 API contract count.

pub const fn is_empty(&self) -> bool

Return whether this response has no rows.

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

Require exactly one row in this response.

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

Require at least one row in this response.

pub fn try_row(self) -> Result<Option<Row<E>>, ResponseError>

Consume and return None for empty, Some(row) for one row, or error for many rows.

pub fn row(self) -> Result<Row<E>, ResponseError>

Consume and return the single row, or fail on zero/many rows.

pub fn rows(self) -> Vec<Row<E>>

Consume and return all rows in response order.

pub fn try_entity(self) -> Result<Option<E>, ResponseError>

Consume and return the single entity or None, failing on many rows.

pub fn entity(self) -> Result<E, ResponseError>

Consume and return the single entity, failing on zero/many rows.

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

Consume and return all entities in response order.

pub fn id(&self) -> Option<Id<E>>

Return the first row identifier, if present.

This identifier is a public value for correlation, reporting, and lookup only.

pub fn require_id(self) -> Result<Id<E>, ResponseError>

Require exactly one row and return its identifier.

pub fn ids(&self) -> Vec<Id<E>>

Return all row identifiers in response order for correlation/reporting/lookup.

pub fn contains_id(&self, id: &Id<E>) -> bool

Check whether the response contains the provided identifier.

pub fn view(&self) -> Result<<E as AsView>::ViewType, ResponseError>

Return the single-row view, failing on zero/many rows.

pub fn view_opt(&self) -> Result<Option<<E as AsView>::ViewType>, ResponseError>

Return an optional single-row view, failing on many rows.

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

Return all row views in response order.

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 = (Id<E>, 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.