Struct EntityRepository 

pub struct EntityRepository<M> { /* private fields */ }

The generic repository: one implementation serving every Model.

Implementations

impl<M> EntityRepository<M>

where M: Model,

pub fn new(db: Database) -> EntityRepository<M>

A repository over db, with no lifecycle hooks.

pub fn with_events(self, events: Arc<Dispatcher>) -> EntityRepository<M>

Dispatch lifecycle hooks through events.

pub fn database(&self) -> &Database

The underlying database handle — the escape hatch for queries this contract does not cover. Reach for it rather than growing the trait.

Trait Implementations

impl<M> Clone for EntityRepository<M>

fn clone(&self) -> EntityRepository<M>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M> Debug for EntityRepository<M>

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

Formats the value using the given formatter.

impl<M> Repository<M> for EntityRepository<M>

where M: Model,

fn all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

Every row. Prefer paginate for anything unbounded.

fn find<'life0, 'async_trait>( &'life0 self, key: Value, ) -> Pin<Box<dyn Future<Output = Result<Option<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

The row with this primary key.

fn find_by<'life0, 'life1, 'async_trait>( &'life0 self, column: &'life1 str, value: Value, ) -> Pin<Box<dyn Future<Output = Result<Vec<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, EntityRepository<M>: 'async_trait,

Every row where column equals value — how a relationship is traversed, since the ORM keeps foreign keys as flat columns.

fn first_by<'life0, 'life1, 'async_trait>( &'life0 self, column: &'life1 str, value: Value, ) -> Pin<Box<dyn Future<Output = Result<Option<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, EntityRepository<M>: 'async_trait,

The first row where column equals value.

fn matching<'life0, 'async_trait>( &'life0 self, criteria: Criteria, ) -> Pin<Box<dyn Future<Output = Result<Vec<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

Every row matching criteria.

fn first_matching<'life0, 'async_trait>( &'life0 self, criteria: Criteria, ) -> Pin<Box<dyn Future<Output = Result<Option<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

The first row matching criteria.

fn count_matching<'life0, 'async_trait>( &'life0 self, criteria: Criteria, ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

How many rows match criteria, ignoring its paging.

fn count_grouped<'life0, 'life1, 'async_trait>( &'life0 self, column: &'life1 str, criteria: Criteria, ) -> Pin<Box<dyn Future<Output = Result<Vec<(RelationKey, u64)>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, EntityRepository<M>: 'async_trait,

SELECT column, COUNT(*) GROUP BY column — how many rows share each value of column.

fn pivot_links<'life0, 'async_trait>( &'life0 self, query: PivotQuery, ) -> Pin<Box<dyn Future<Output = Result<Vec<(Value, Value)>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

Read a pivot table’s (parent, related) links.

fn paginate_matching<'life0, 'async_trait>( &'life0 self, criteria: Criteria, page: u64, per_page: u64, ) -> Pin<Box<dyn Future<Output = Result<Paginated<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

One page of rows matching criteria.

fn create<'life0, 'async_trait>( &'life0 self, model: M, ) -> Pin<Box<dyn Future<Output = Result<M, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

Insert a row, returning it with any database-assigned key.

fn update<'life0, 'life1, 'async_trait>( &'life0 self, model: &'life1 M, ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, EntityRepository<M>: 'async_trait,

Update every non-key column of a row, matched by its primary key.

fn upsert<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'async_trait>( &'life0 self, model: &'life1 M, conflict_columns: &'life2 [&'life3 str], update_columns: &'life4 [&'life5 str], ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait, EntityRepository<M>: 'async_trait,

Insert, or update on a conflict with conflict_columns. An empty update_columns makes it insert-or-ignore.

fn delete<'life0, 'async_trait>( &'life0 self, key: Value, ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

Delete the row with this primary key.

fn delete_matching<'life0, 'async_trait>( &'life0 self, criteria: Criteria, ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, EntityRepository<M>: 'async_trait,

Delete every row matching criteria. Returns rows affected.

fn find_key<'life0, 'async_trait>( &'life0 self, key: impl Into<Value> + Send + 'async_trait, ) -> Pin<Box<dyn Future<Output = Result<Option<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + 'async_trait,

find with a key of any convertible type.

fn find_or_fail<'life0, 'async_trait>( &'life0 self, key: impl Into<Value> + Send + 'async_trait, ) -> Pin<Box<dyn Future<Output = Result<M, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + 'async_trait,

find, failing with a 404 naming the model when there is no such row — what a controller almost always wants.

fn find_by_route_key<'life0, 'async_trait>( &'life0 self, value: impl Into<Value> + Send + 'async_trait, ) -> Pin<Box<dyn Future<Output = Result<Option<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + 'async_trait,

The row whose route key equals value — route-model binding’s lookup.

fn where_eq<'life0, 'life1, 'async_trait>( &'life0 self, column: &'life1 str, value: impl Into<Value> + Send + 'async_trait, ) -> Pin<Box<dyn Future<Output = Result<Vec<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: Sized + 'async_trait,

Every row where column equals a value of any convertible type.

fn count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + 'async_trait,

How many rows there are in total.

fn paginate<'life0, 'async_trait>( &'life0 self, page: u64, per_page: u64, ) -> Pin<Box<dyn Future<Output = Result<Paginated<M>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + 'async_trait,

One page of every row.

fn exists<'life0, 'async_trait>( &'life0 self, criteria: Criteria, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sized + 'async_trait,

Whether any row matches criteria.