Trait HomeserverConnection

pub trait HomeserverConnection: Send + Sync {
    // Required methods
    fn homeserver(&self) -> &str;
    fn verify_token<'life0, 'life1, 'async_trait>(
        &'life0 self,
        token: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn query_user<'life0, 'life1, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<MatrixUser, Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn provision_user<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 ProvisionRequest,
    ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn is_localpart_available<'life0, 'life1, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn upsert_device<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
        device_id: &'life2 str,
        initial_display_name: Option<&'life3 str>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait;
    fn update_device_display_name<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
        device_id: &'life2 str,
        display_name: &'life3 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait;
    fn delete_device<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
        device_id: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn sync_devices<'life0, 'life1, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
        devices: HashSet<String>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn delete_user<'life0, 'life1, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
        erase: bool,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn reactivate_user<'life0, 'life1, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn set_displayname<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
        displayname: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn unset_displayname<'life0, 'life1, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn allow_cross_signing_reset<'life0, 'life1, 'async_trait>(
        &'life0 self,
        localpart: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;

    // Provided methods
    fn mxid(&self, localpart: &str) -> String { ... }
    fn localpart<'a>(&self, mxid: &'a str) -> Option<&'a str> { ... }
}

Required Methods

fn homeserver(&self) -> &str

Get the homeserver URL.

fn verify_token<'life0, 'life1, 'async_trait>( &'life0 self, token: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

Verify a bearer token coming from the homeserver for homeserver to MAS interactions

Returns true if the token is valid, false otherwise.

Parameters

• token - The token to verify.

Errors

Returns an error if the token failed to verify.

fn query_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<MatrixUser, Error>> + Send + 'async_trait>>

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

Query the state of a user on the homeserver.

Parameters

• localpart - The localpart of the user to query.

Errors

Returns an error if the homeserver is unreachable or the user does not exist.

fn provision_user<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 ProvisionRequest, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

Provision a user on the homeserver.

Parameters

• request - a ProvisionRequest containing the details of the user to provision.

Errors

Returns an error if the homeserver is unreachable or the user could not be provisioned.

fn is_localpart_available<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

Check whether a given username is available on the homeserver.

Parameters

• localpart - The localpart to check.

Errors

Returns an error if the homeserver is unreachable.

fn upsert_device<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, initial_display_name: Option<&'life3 str>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Create a device for a user on the homeserver.

Parameters

• localpart - The localpart of the user to create a device for.
• device_id - The device ID to create.

Errors

Returns an error if the homeserver is unreachable or the device could not be created.

fn update_device_display_name<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, display_name: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Update the display name of a device for a user on the homeserver.

Parameters

• localpart - The localpart of the user to update a device for.
• device_id - The device ID to update.
• display_name - The new display name to set

Errors

Returns an error if the homeserver is unreachable or the device could not be updated.

fn delete_device<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Delete a device for a user on the homeserver.

Parameters

• localpart - The localpart of the user to delete a device for.
• device_id - The device ID to delete.

Errors

Returns an error if the homeserver is unreachable or the device could not be deleted.

fn sync_devices<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, devices: HashSet<String>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Sync the list of devices of a user with the homeserver.

Parameters

• localpart - The localpart of the user to sync the devices for.
• devices - The list of devices to sync.

Errors

Returns an error if the homeserver is unreachable or the devices could not be synced.

fn delete_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, erase: bool, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Delete a user on the homeserver.

Parameters

• localpart - The localpart of the user to delete.
• erase - Whether to ask the homeserver to erase the user’s data.

Errors

Returns an error if the homeserver is unreachable or the user could not be deleted.

fn reactivate_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Reactivate a user on the homeserver.

Parameters

• localpart - The localpart of the user to reactivate.

Errors

Returns an error if the homeserver is unreachable or the user could not be reactivated.

fn set_displayname<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, localpart: &'life1 str, displayname: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Set the displayname of a user on the homeserver.

Parameters

• localpart - The localpart of the user to set the displayname for.
• displayname - The displayname to set.

Errors

Returns an error if the homeserver is unreachable or the displayname could not be set.

fn unset_displayname<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Unset the displayname of a user on the homeserver.

Parameters

• localpart - The localpart of the user to unset the displayname for.

Errors

Returns an error if the homeserver is unreachable or the displayname could not be unset.

fn allow_cross_signing_reset<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Temporarily allow a user to reset their cross-signing keys.

Parameters

• localpart - The localpart of the user to allow cross-signing key reset

Errors

Returns an error if the homeserver is unreachable or the cross-signing reset could not be allowed.

Provided Methods

fn mxid(&self, localpart: &str) -> String

Get the Matrix ID of the user with the given localpart.

Parameters

• localpart - The localpart of the user.

fn localpart<'a>(&self, mxid: &'a str) -> Option<&'a str>

Get the localpart of a Matrix ID if it has the right server name

Returns None if the input isn’t a valid MXID, or if the server name doesn’t match

Parameters

• mxid - The MXID of the user

Implementations on Foreign Types

impl<T: HomeserverConnection + Send + Sync + ?Sized> HomeserverConnection for &T

fn homeserver(&self) -> &str

fn verify_token<'life0, 'life1, 'async_trait>( &'life0 self, token: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

fn query_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<MatrixUser, Error>> + Send + 'async_trait>>

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

fn provision_user<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 ProvisionRequest, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

fn is_localpart_available<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

fn upsert_device<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, initial_display_name: Option<&'life3 str>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn update_device_display_name<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, display_name: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn delete_device<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn sync_devices<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, devices: HashSet<String>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn delete_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, erase: bool, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn reactivate_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn set_displayname<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, localpart: &'life1 str, displayname: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn unset_displayname<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn allow_cross_signing_reset<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

impl<T: HomeserverConnection + ?Sized> HomeserverConnection for Arc<T>

fn homeserver(&self) -> &str

fn verify_token<'life0, 'life1, 'async_trait>( &'life0 self, token: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

fn query_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<MatrixUser, Error>> + Send + 'async_trait>>

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

fn provision_user<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 ProvisionRequest, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

fn is_localpart_available<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

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

fn upsert_device<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, initial_display_name: Option<&'life3 str>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn update_device_display_name<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, display_name: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn delete_device<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, localpart: &'life1 str, device_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn sync_devices<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, devices: HashSet<String>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn delete_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, erase: bool, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn reactivate_user<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn set_displayname<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, localpart: &'life1 str, displayname: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn unset_displayname<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

fn allow_cross_signing_reset<'life0, 'life1, 'async_trait>( &'life0 self, localpart: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Implementors

impl HomeserverConnection for HomeserverConnection

impl<C: HomeserverConnection> HomeserverConnection for ReadOnlyHomeserverConnection<C>