pub struct EdgeCollection<Row, Db: Database> { /* private fields */ }sqlx only.Expand description
One collection column of a row, and how this database materializes it over a page.
§It is DECLARED rather than deduced, for the reason the strategy one level down is
Whether a column is a collection at all, what shape its edge table has, and which of the two
materializations this database takes are three facts about a DECLARATION. A Vec<T> behind an
alias is a scalar to anything reading tokens, so nothing can recover them by looking; the party
that wrote the declaration states them, which is exactly what
PgCollectionStorage already asks of an element
type.
§A column named here is NOT in SqlQuery::COLUMNS
That is the contract, and it is what makes both materializations one rule rather than two: a gathered column has no value on the page row to select, and an aggregated one is an EXPRESSION the engine renders rather than a column name. Selecting it as a bare name would ask the page’s own table for a column that is not in it.
§The typed halves are function pointers, and that is what keeps them typed
An element’s type is the declaration’s, so nothing generic over the dialect can name it. What
the engine owns is the STATEMENT — the edge table, the membership, the order, the connection and
the bind ceiling — and what a declaration owns is the crossing at each end. aggregated and
distribute are those crossings written ONCE, so a plan entry names the types and is not a
place where the grouping could be got wrong.
Implementations§
Source§impl<Row, Db: Database> EdgeCollection<Row, Db>
impl<Row, Db: Database> EdgeCollection<Row, Db>
Sourcepub const fn aggregate(
path: &'static [&'static FieldName],
shape: EdgeShape,
take: fn(&mut Row, &<Db as Database>::Row, &str) -> Result<(), Error>,
) -> Self
pub const fn aggregate( path: &'static [&'static FieldName], shape: EdgeShape, take: fn(&mut Row, &<Db as Database>::Row, &str) -> Result<(), Error>, ) -> Self
A collection this database aggregates into a native array on the page row.
path names the column from the ROW down — one segment for a column of the row itself, and
one per level for a column of a composite inside it, which is the same path
edge_table derives the second table’s name from.
Sourcepub const fn gather(
path: &'static [&'static FieldName],
shape: EdgeShape,
key: fn(&Row, usize, &mut QueryBuilder<Db>),
take: fn(&mut [Row], &[<Db as Database>::Row]) -> Result<(), Error>,
) -> Self
pub const fn gather( path: &'static [&'static FieldName], shape: EdgeShape, key: fn(&Row, usize, &mut QueryBuilder<Db>), take: fn(&mut [Row], &[<Db as Database>::Row]) -> Result<(), Error>, ) -> Self
A collection this database gathers in a second statement, batched over the page’s keys.
key binds one of this row’s key columns — the engine writes the parentheses, the commas and
the membership around it, so a plan states the VALUES and nothing about the statement.
Sourcepub const fn gather_composite(
path: &'static [&'static FieldName],
shape: EdgeShape,
segments: &'static [&'static FieldName],
key: fn(&Row, usize, &mut QueryBuilder<Db>),
take: fn(&mut [Row], &[<Db as Database>::Row]) -> Result<(), Error>,
) -> Self
pub const fn gather_composite( path: &'static [&'static FieldName], shape: EdgeShape, segments: &'static [&'static FieldName], key: fn(&Row, usize, &mut QueryBuilder<Db>), take: fn(&mut [Row], &[<Db as Database>::Row]) -> Result<(), Error>, ) -> Self
A collection of COMPOSITE elements, gathered — segments names what one element’s type spans,
each column projected under ELEMENT framed by that segment.
§There is no aggregate twin, and the absence IS the refusal
array_agg takes ONE expression, and a composite element is several columns that have to
arrive together — so the aggregate materialization has nothing to put on the page row, and a
plan that could name it would be a statement no dialect renders. The gather already carries
several columns per row, which is what makes it the general form rather than the fallback.
A caller reaching for aggregate with a composite element therefore has no
constructor to reach for, which is where this crate puts a refusal it can make structural — the
standing EdgeShape itself takes, where a set’s table has no ordinal because the type that
derives one is never built for it.
Auto Trait Implementations§
impl<Row, Db> Freeze for EdgeCollection<Row, Db>where
Plan<Row, Db>: Freeze,
impl<Row, Db> RefUnwindSafe for EdgeCollection<Row, Db>where
Plan<Row, Db>: RefUnwindSafe,
impl<Row, Db> Send for EdgeCollection<Row, Db>where
Plan<Row, Db>: Send,
impl<Row, Db> Sync for EdgeCollection<Row, Db>where
Plan<Row, Db>: Sync,
impl<Row, Db> Unpin for EdgeCollection<Row, Db>where
Plan<Row, Db>: Unpin,
impl<Row, Db> UnsafeUnpin for EdgeCollection<Row, Db>where
Plan<Row, Db>: UnsafeUnpin,
impl<Row, Db> UnwindSafe for EdgeCollection<Row, Db>where
Plan<Row, Db>: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.impl<T> Fruit for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.