Struct Manager 

pub struct Manager<DBCP>
where
    DBCP: DBProvider,
{ /* private fields */ }

The manager and the data controller for the session model.

Implementations

impl<DBCP> Manager<DBCP>

where DBCP: DBProvider,

pub fn builder() -> ManagerBuilder<DBCP>

Creates a new builder for this struct.

impl<DBCP> Manager<DBCP>

where DBCP: DBProvider,

pub async fn get_by_session_id(&self, session_id: i64) -> Result<Vec<Model>>

Get session by its ID.

Trait Implementations

impl<DBCP> Child for Manager<DBCP>

where DBCP: DBProvider,

type WeakParent = Weak<DBCP>

Type of weak reference to the parent.

type FXPParent = Weak<DBCP>

For use of the child_build! and child_builder! macros.

type RcParent = Result<Arc<DBCP>, SimErrorAny>

Type of strong reference to the parent.

fn parent(&self) -> Self::RcParent

Return a strong reference to the parent.

fn parent_downgrade(&self) -> Self::WeakParent

Return a weak reference to the parent.

fn __fxplus_parent(parent: Self::WeakParent) -> Self::FXPParent

impl<DBCP> DCCommon<Entity, DBCP, true> for Manager<DBCP>

where DBCP: DBProvider,

fn delete_many_condition( dm: DeleteMany<Entity>, keys: Vec<Self::Key>, ) -> DeleteMany<Entity>

Provide correct condition for SeaORM’s DeleteMany operation. See, for example, CustomerManager::delete_many_condition source code.

fn db_provider(&self) -> <Self as Child>::RcParent

Where we get our database connection from.

fn wbdc_write_back<'life0, 'async_trait>( &'life0 self, update_records: Arc<UpdateIterator<Self>>, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

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

Try to send given update records to the database in the most efficient way. This task is accomplished by:

fn wbdbc_on_new<'life0, 'life1, 'life2, 'async_trait, AM>( &'life0 self, _key: &'life1 Self::Key, value: &'life2 AM, ) -> Pin<Box<dyn Future<Output = Result<DataControllerResponse<Self>, Self::Error>> + Send + 'async_trait>>

where AM: Into<T::ActiveModel> + Clone + Send + Sync + 'static + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

For every new data record added this method respond with [CacheUpdates::Insert(record_active_mode)] update. The DataControllerOp depends on the IMMUTABLE flag: if it is set to true, the operation is DataControllerOp::Insert, otherwise it is DataControllerOp::Nop.

fn wbdc_on_delete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _key: &'life1 Self::Key, update: Option<&'life2 CacheUpdates<T::ActiveModel>>, ) -> Pin<Box<dyn Future<Output = Result<DataControllerResponse<Self>, Self::Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute record deletion.

fn wbdc_on_change<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 Self::Key, value: &'life2 Self::Value, old_value: Self::Value, prev_update: Option<Self::CacheUpdate>, ) -> Pin<Box<dyn Future<Output = Result<DataControllerResponse<Self>, Self::Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called when a record is modified by the user.

impl<DBCP> DataController for Manager<DBCP>

where DBCP: DBProvider,

type CacheUpdate = CacheUpdates<ActiveModel>

The type of the update pool records that are produced by the data controller.

type Error = SimErrorAny

The error type that the data controller can return. Note that this is the only error type the the cache controller is using!

type Key = i64

The key type to be used with methods like Cache::get() or Cache::entry().

type Value = Model

The record type to be stored in the cache and maintained by the data controller.

fn get_for_key<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 Self::Key, ) -> Pin<Box<dyn Future<Output = Result<Option<Self::Value>>> + Send + 'async_trait>>

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

Must return the value for the given key, if it exists, None otherwise.

fn primary_key_of(&self, value: &Self::Value) -> Self::Key

Returns the primary key for the given value.

fn write_back<'life0, 'async_trait>( &'life0 self, update_records: Arc<UpdateIterator<Self>>, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Given a list of update records, must apply these updates to the underlying backend.

fn on_new<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 Self::Key, value: &'life2 Self::Value, ) -> Pin<Box<dyn Future<Output = Result<DataControllerResponse<Self>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called when a new record is added to the cache. On success, it must return a DataControllerResponse with the operation type set to what the data controller considers appropriate for the new record. For example, if it is known that the new record will have exactly the same field values after being written to the backend as it had when submitted to this method, then the operation can be set to DataControllerOp::Insert.

fn on_delete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 Self::Key, update: Option<&'life2 CacheUpdates<ActiveModel>>, ) -> Pin<Box<dyn Future<Output = Result<DataControllerResponse<Self>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called when there is a delete request for the given key has been received. Don’t mix it up with the invalidate request which is only clearing a cache entry.

fn on_change<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 Self::Key, value: &'life2 Self::Value, old_value: Self::Value, prev_update: Option<Self::CacheUpdate>, ) -> Pin<Box<dyn Future<Output = Result<DataControllerResponse<Self>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called when a record is modified by the user.

fn secondary_keys_of(&self, _value: &Self::Value) -> Vec<Self::Key>

Returns a list of secondary keys for the given value. Default implementation returns an empty vector.

fn get_primary_key_for<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 Self::Key, ) -> Pin<Box<dyn Future<Output = Result<Option<Self::Key>, Self::Error>> + Send + 'async_trait>>

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

Take a key and return its corresponding primary key. This operation may require a backend request.

fn is_primary(&self, _key: &Self::Key) -> bool

Returns true if the given key is considered the primary key.

fn on_access<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _key: &'life1 Self::Key, _value: &'life2 Self::Value, prev_update: Option<Self::CacheUpdate>, ) -> Pin<Box<dyn Future<Output = Result<DataControllerResponse<Self>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

This method is called on every access to the given key in the cache. It can be used to implement various related functionality like updateing the access time column in the backend, or calculating related metrics or statistics.

impl<DBCP> Debug for Manager<DBCP>

where DBCP: DBProvider,

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

Formats the value using the given formatter.

impl<DBCP> FXStruct for Manager<DBCP>

where DBCP: DBProvider,