Skip to main content

EntityRepository

Struct EntityRepository 

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

The generic repository: one implementation serving every Model.

Implementations§

Source§

impl<M: Model> EntityRepository<M>

Source

pub fn new(db: Database) -> Self

A repository over db, with no lifecycle hooks.

Source

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

Dispatch lifecycle hooks through events.

Source

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§

Source§

impl<M> Clone for EntityRepository<M>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M> Debug for EntityRepository<M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<M: Model> Repository<M> for EntityRepository<M>

Source§

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

Every row. Prefer paginate for anything unbounded.
Source§

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

The row with this primary key.
Source§

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

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

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

The first row where column equals value.
Source§

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

Every row matching criteria.
Source§

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

The first row matching criteria.
Source§

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

How many rows match criteria, ignoring its paging.
Source§

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

SELECT column, COUNT(*) GROUP BY column — how many rows share each value of column. Read more
Read a pivot table’s (parent, related) links. Read more
Source§

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

One page of rows matching criteria.
Source§

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

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

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

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

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>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait,

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

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

Delete the row with this primary key.
Source§

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

Delete every row matching criteria. Returns rows affected.
Source§

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

find with a key of any convertible type.
Source§

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

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

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

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

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

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

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

How many rows there are in total.
Source§

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

One page of every row.
Source§

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

Whether any row matches criteria.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Event for T
where T: Send + Sync + 'static,

Source§

fn event_name() -> &'static str
where Self: Sized,

A human-readable name, used by wildcard listeners and log output. Always the Rust type path; see the trait docs.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more