Struct xaynet_server::storage::store::Store

pub struct Store<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage,  { /* fields omitted */ }

A generic store.

Implementations

impl<C, M> Store<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage, 

pub fn new(coordinator: C, model: M) -> Self

Creates a new Store.

pub async fn is_ready(&mut self) -> StorageResult<()>

Checks if the Store is ready to process requests.

Behavior

If the Store is ready to process requests, return StorageResult::Ok(()). If the Store cannot process requests because of a connection error, for example, return StorageResult::Err(error).

Trait Implementations

impl<C: Clone, M: Clone> Clone for Store<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage, 

pub fn clone(&self) -> Store<C, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, M> CoordinatorStorage for Store<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage, 

pub fn set_coordinator_state<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    state: &'life1 CoordinatorState
) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Sets a CoordinatorState.

pub fn coordinator_state<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<Option<CoordinatorState>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a CoordinatorState.

pub fn add_sum_participant<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    pk: &'life1 SumParticipantPublicKey,
    ephm_pk: &'life2 SumParticipantEphemeralPublicKey
) -> Pin<Box<dyn Future<Output = StorageResult<SumPartAdd>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Adds a sum participant entry to the SumDict.

pub fn sum_dict<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<Option<SumDict>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the SumDict.

pub fn add_local_seed_dict<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    update_pk: &'life1 UpdateParticipantPublicKey,
    local_seed_dict: &'life2 LocalSeedDict
) -> Pin<Box<dyn Future<Output = StorageResult<LocalSeedDictAdd>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Adds a local LocalSeedDict of the given UpdateParticipantPublicKey to the SeedDict.

pub fn seed_dict<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<Option<SeedDict>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the SeedDict.

pub fn incr_mask_score<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    pk: &'life1 SumParticipantPublicKey,
    mask: &'life2 MaskObject
) -> Pin<Box<dyn Future<Output = StorageResult<MaskScoreIncr>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Increments the mask score with the given MaskObjectb by one.

pub fn best_masks<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<Option<Vec<(MaskObject, u64)>>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the two masks with the highest score.

pub fn number_of_unique_masks<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<u64>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the number of unique masks.

pub fn delete_coordinator_data<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes all coordinator data. This includes the coordinator state as well as the SumDict, SeedDict and mask dictionary.

pub fn delete_dicts<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the SumDict, SeedDict and mask dictionary.

pub fn set_latest_global_model_id<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    id: &'life1 str
) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Sets the latest global model id.

pub fn latest_global_model_id<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<Option<String>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the latest global model id.

pub fn is_ready<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Checks if the CoordinatorStorage is ready to process requests.

impl<C, M> ModelStorage for Store<C, M> where
    C: CoordinatorStorage,
    M: ModelStorage, 

pub fn set_global_model<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 mut self,
    round_id: u64,
    round_seed: &'life1 RoundSeed,
    global_model: &'life2 Model
) -> Pin<Box<dyn Future<Output = StorageResult<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Sets a global model.

pub fn global_model<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    id: &'life1 str
) -> Pin<Box<dyn Future<Output = StorageResult<Option<Model>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns a global model.

pub fn is_ready<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Checks if the ModelStorage is ready to process requests.

pub fn create_global_model_id(round_id: u64, round_seed: &RoundSeed) -> String

Creates a unique global model id by using the round id and the round seed in which the global model was created.