pub struct MetaClientInit;Trait Implementations§
source§impl ClientModuleInit for MetaClientInit
impl ClientModuleInit for MetaClientInit
Generates the client module
type Module = MetaClientModule
source§fn supported_api_versions(&self) -> MultiApiVersion
fn supported_api_versions(&self) -> MultiApiVersion
Api versions of the corresponding server side module’s API
that this client module implementation can use.
source§fn init<'life0, 'life1, 'async_trait>(
&'life0 self,
args: &'life1 ClientModuleInitArgs<Self>,
) -> Pin<Box<dyn Future<Output = Result<Self::Module>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn init<'life0, 'life1, 'async_trait>(
&'life0 self,
args: &'life1 ClientModuleInitArgs<Self>,
) -> Pin<Box<dyn Future<Output = Result<Self::Module>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Initialize a
ClientModule instance from its configsource§fn get_database_migrations(
&self,
) -> BTreeMap<DatabaseVersion, ClientMigrationFn>
fn get_database_migrations( &self, ) -> BTreeMap<DatabaseVersion, ClientMigrationFn>
Retrieves the database migrations from the module to be applied to the
database before the module is initialized. The database migrations map
is indexed on the “from” version.
source§fn recover<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_args: &'life1 ClientModuleRecoverArgs<Self>,
_snapshot: Option<&'life2 <Self::Module as ClientModule>::Backup>,
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Self: Sync + 'async_trait,
fn recover<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
_args: &'life1 ClientModuleRecoverArgs<Self>,
_snapshot: Option<&'life2 <Self::Module as ClientModule>::Backup>,
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Self: Sync + 'async_trait,
Recover the state of the client module, optionally from an existing
snapshot. Read more
source§impl Clone for MetaClientInit
impl Clone for MetaClientInit
source§fn clone(&self) -> MetaClientInit
fn clone(&self) -> MetaClientInit
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for MetaClientInit
impl Debug for MetaClientInit
source§impl ModuleInit for MetaClientInit
impl ModuleInit for MetaClientInit
source§const DATABASE_VERSION: DatabaseVersion = _
const DATABASE_VERSION: DatabaseVersion = _
This represents the module’s database version that the current code is
compatible with. It is important to increment this value whenever a
key or a value that is persisted to the database within the module
changes. It is also important to add the corresponding
migration function in
get_database_migrations which should define how
to move from the previous database version to the current version.type Common = MetaCommonInit
async fn dump_database( &self, _dbtx: &mut DatabaseTransaction<'_>, prefix_names: Vec<String>, ) -> Box<dyn Iterator<Item = (String, Box<dyn Serialize + Send>)> + '_>
Auto Trait Implementations§
impl Freeze for MetaClientInit
impl RefUnwindSafe for MetaClientInit
impl Send for MetaClientInit
impl Sync for MetaClientInit
impl Unpin for MetaClientInit
impl UnwindSafe for MetaClientInit
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
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit)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,
Causes
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,
Causes
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,
Causes
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,
Causes
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,
Causes
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,
Causes
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,
Causes
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,
Causes
self to use its UpperHex implementation when
Debug-formatted.source§impl<T> IClientModuleInit for T
impl<T> IClientModuleInit for T
fn decoder(&self) -> Decoder
fn module_kind(&self) -> ModuleKind
fn as_common(&self) -> &(dyn IDynCommonModuleInit + Send + Sync + 'static)
source§fn supported_api_versions(&self) -> MultiApiVersion
fn supported_api_versions(&self) -> MultiApiVersion
fn recover<'life0, 'life1, 'async_trait>(
&'life0 self,
final_client: FinalClient,
federation_id: FederationId,
num_peers: NumPeers,
cfg: ClientModuleConfig,
db: Database,
instance_id: u16,
core_api_version: ApiVersion,
module_api_version: ApiVersion,
module_root_secret: DerivableSecret,
notifier: Notifier,
api: DynGlobalApi,
admin_auth: Option<ApiAuth>,
snapshot: Option<&'life1 DynModuleBackup>,
progress_tx: Sender<RecoveryProgress>,
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
T: 'async_trait,
fn init<'life0, 'async_trait>(
&'life0 self,
final_client: FinalClient,
federation_id: FederationId,
peer_num: usize,
cfg: ClientModuleConfig,
db: Database,
instance_id: u16,
core_api_version: ApiVersion,
module_api_version: ApiVersion,
module_root_secret: DerivableSecret,
notifier: Notifier,
api: DynGlobalApi,
admin_auth: Option<ApiAuth>,
task_group: TaskGroup,
) -> Pin<Box<dyn Future<Output = Result<DynClientModule, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
fn get_database_migrations( &self, ) -> BTreeMap<DatabaseVersion, for<'r, 'tx> fn(_: &'r mut DatabaseTransaction<'tx>, _: Vec<(Vec<u8>, OperationId)>, _: Vec<(Vec<u8>, OperationId)>) -> Pin<Box<dyn Future<Output = Result<Option<(Vec<(Vec<u8>, OperationId)>, Vec<(Vec<u8>, OperationId)>)>, Error>> + Send + 'r>>>
source§impl<T> IDynCommonModuleInit for Twhere
T: ModuleInit,
impl<T> IDynCommonModuleInit for Twhere
T: ModuleInit,
fn decoder(&self) -> Decoder
fn module_kind(&self) -> ModuleKind
fn to_dyn_common(&self) -> DynCommonModuleInit
fn database_version(&self) -> DatabaseVersion
fn dump_database<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
dbtx: &'life1 mut DatabaseTransaction<'life2>,
prefix_names: Vec<String>,
) -> Pin<Box<dyn Future<Output = Box<dyn Iterator<Item = (String, Box<dyn Serialize + Send>)> + 'life0>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
T: 'async_trait,
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>
Converts
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>
Converts
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,
Pipes by value. This is generally the method you want to use. Read more
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,
Borrows
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,
Mutably borrows
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
Borrows
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
Mutably borrows
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
Borrows
self, then passes self.deref() into the pipe function.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
Immutable access to the
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
Mutable access to the
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
Immutable access to the
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
Mutable access to the
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
Immutable access to the
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
Mutable access to the
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
Calls
.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
Calls
.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
Calls
.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
Calls
.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
Calls
.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
Calls
.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
Calls
.tap_deref() only in debug builds, and is erased in release
builds.