Struct Service 

pub struct Service {
    appservice_in_room_cache: RwLock<HashMap<OwnedRoomId, HashMap<String, bool>>>,
    services: Arc<OnceServices>,
    db: Data,
}

Fields

appservice_in_room_cache: RwLock<HashMap<OwnedRoomId, HashMap<String, bool>>>

services: Arc<OnceServices>

db: Data

Implementations

impl Service

pub async fn update_membership( &self, room_id: &RoomId, user_id: &UserId, membership_event: RoomMemberEventContent, sender: &UserId, last_state: Option<Vec<Raw<AnyStrippedStateEvent>>>, invite_via: Option<Vec<OwnedServerName>>, update_joined_count: bool, count: PduCount, ) -> Result

Update current membership data.

impl Service

pub async fn update_joined_count(&self, room_id: &RoomId)

impl Service

pub(crate) fn mark_as_joined( &self, user_id: &UserId, room_id: &RoomId, count: PduCount, )

Direct DB function to directly mark a user as joined. It is not recommended to use this directly. You most likely should use update_membership instead

impl Service

pub(crate) fn mark_as_left( &self, user_id: &UserId, room_id: &RoomId, count: PduCount, )

Direct DB function to directly mark a user as left. It is not recommended to use this directly. You most likely should use update_membership instead

impl Service

pub(crate) fn _mark_as_knocked( &self, user_id: &UserId, room_id: &RoomId, count: PduCount, knocked_state: Option<Vec<Raw<AnyStrippedStateEvent>>>, )

Direct DB function to directly mark a user as knocked. It is not recommended to use this directly. You most likely should use update_membership instead

impl Service

pub fn forget(&self, room_id: &RoomId, user_id: &UserId)

Makes a user forget a room.

impl Service

fn mark_as_once_joined(&self, user_id: &UserId, room_id: &RoomId)

impl Service

pub(crate) async fn mark_as_invited( &self, user_id: &UserId, room_id: &RoomId, count: PduCount, last_state: Option<Vec<Raw<AnyStrippedStateEvent>>>, invite_via: Option<Vec<OwnedServerName>>, )

impl Service

pub async fn add_servers_invite_via( &self, room_id: &RoomId, servers: Vec<OwnedServerName>, )

impl Service

pub async fn servers_route_via( &self, room_id: &RoomId, ) -> Result<Vec<OwnedServerName>>

Gets up to five servers that are likely to be in the room in the distant future.

See https://spec.matrix.org/latest/appendices/#routing

impl Service

pub fn servers_invite_via<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &ServerName> + Send + 'a

impl Service

pub async fn appservice_in_room( &self, room_id: &RoomId, appservice: &RegistrationInfo, ) -> bool

impl Service

pub fn get_appservice_in_room_cache_usage(&self) -> (usize, usize)

impl Service

pub fn clear_appservice_in_room_cache(&self)

impl Service

pub fn room_servers<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &ServerName> + Send + 'a

Returns an iterator of all servers participating in this room.

impl Service

pub async fn server_in_room<'a>( &'a self, server: &'a ServerName, room_id: &'a RoomId, ) -> bool

impl Service

pub fn server_rooms<'a>( &'a self, server: &'a ServerName, ) -> impl Stream<Item = &RoomId> + Send + 'a

Returns an iterator of all rooms a server participates in (as far as we know).

impl Service

pub async fn server_sees_user( &self, server: &ServerName, user_id: &UserId, ) -> bool

Returns true if server can see user by sharing at least one room.

impl Service

pub async fn user_sees_user(&self, user_a: &UserId, user_b: &UserId) -> bool

Returns true if user_a and user_b share at least one room.

impl Service

pub fn get_shared_rooms<'a>( &'a self, user_a: &'a UserId, user_b: &'a UserId, ) -> impl Stream<Item = &RoomId> + Send + 'a

List the rooms common between two users

impl Service

pub fn room_members<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &UserId> + Send + 'a

Returns an iterator of all joined members of a room.

impl Service

pub async fn room_joined_count(&self, room_id: &RoomId) -> Result<u64>

Returns the number of users which are currently in a room

impl Service

pub async fn room_invited_count(&self, room_id: &RoomId) -> Result<u64>

Returns the number of users which are currently invited to a room

impl Service

pub async fn room_knocked_count(&self, room_id: &RoomId) -> Result<u64>

Returns the number of users which are currently knocking upon a room

impl Service

pub fn active_local_users_in_room<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &UserId> + Send + 'a

Returns an iterator of all our local joined users in a room who are active (not deactivated, not guest)

impl Service

pub fn local_users_in_room<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &UserId> + Send + 'a

Returns an iterator of all our local users in the room, even if they’re deactivated/guests

impl Service

pub fn local_users_invited_to_room<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &UserId> + Send + 'a

Returns an iterator of only our users invited to this room.

impl Service

pub fn room_useroncejoined<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &UserId> + Send + 'a

Returns an iterator over all User IDs who ever joined a room.

impl Service

pub fn room_members_invited<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &UserId> + Send + 'a

Returns an iterator over all invited members of a room.

impl Service

pub fn room_members_knocked<'a>( &'a self, room_id: &'a RoomId, ) -> impl Stream<Item = &UserId> + Send + 'a

Returns an iterator over all knocked members of a room.

impl Service

pub async fn get_invite_count( &self, room_id: &RoomId, user_id: &UserId, ) -> Result<u64>

impl Service

pub async fn get_knock_count( &self, room_id: &RoomId, user_id: &UserId, ) -> Result<u64>

impl Service

pub async fn get_left_count( &self, room_id: &RoomId, user_id: &UserId, ) -> Result<u64>

impl Service

pub async fn get_joined_count( &self, room_id: &RoomId, user_id: &UserId, ) -> Result<u64>

impl Service

pub fn all_user_memberships<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = (MembershipState, &RoomId)> + Send + 'a

Returns an iterator over all memberships for a user.

impl Service

pub fn user_memberships<'a>( &'a self, user_id: &'a UserId, mask: Option<&[MembershipState]>, ) -> impl Stream<Item = (MembershipState, &RoomId)> + Send + 'a

Returns an iterator over all specified memberships for a user.

impl Service

pub fn rooms_joined<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = &RoomId> + Send + 'a

Returns an iterator over all rooms this user joined.

impl Service

pub fn rooms_invited<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = &RoomId> + Send + 'a

Returns an iterator over all rooms a user was invited to.

impl Service

pub fn rooms_knocked<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = &RoomId> + Send + 'a

Returns an iterator over all rooms a user is currently knocking.

impl Service

pub fn rooms_left<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = &RoomId> + Send + 'a

Returns an iterator over all rooms a user left.

impl Service

pub fn rooms_invited_state<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = (OwnedRoomId, Vec<Raw<AnyStrippedStateEvent>>)> + Send + 'a

Returns an iterator over all rooms a user was invited to.

impl Service

pub fn rooms_knocked_state<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = (OwnedRoomId, Vec<Raw<AnyStrippedStateEvent>>)> + Send + 'a

Returns an iterator over all rooms a user is currently knocking.

impl Service

pub fn rooms_left_state<'a>( &'a self, user_id: &'a UserId, ) -> impl Stream<Item = (OwnedRoomId, Vec<Raw<AnySyncStateEvent>>)> + Send + 'a

Returns an iterator over all rooms a user left.

impl Service

pub async fn invite_state( &self, user_id: &UserId, room_id: &RoomId, ) -> Result<Vec<Raw<AnyStrippedStateEvent>>>

impl Service

pub async fn knock_state( &self, user_id: &UserId, room_id: &RoomId, ) -> Result<Vec<Raw<AnyStrippedStateEvent>>>

impl Service

pub async fn left_state( &self, user_id: &UserId, room_id: &RoomId, ) -> Result<Vec<Raw<AnyStrippedStateEvent>>>

impl Service

pub async fn user_membership( &self, user_id: &UserId, room_id: &RoomId, ) -> Option<MembershipState>

impl Service

pub async fn once_joined(&self, user_id: &UserId, room_id: &RoomId) -> bool

impl Service

pub async fn is_joined<'a>( &'a self, user_id: &'a UserId, room_id: &'a RoomId, ) -> bool

impl Service

pub async fn is_knocked<'a>( &'a self, user_id: &'a UserId, room_id: &'a RoomId, ) -> bool

impl Service

pub async fn is_invited(&self, user_id: &UserId, room_id: &RoomId) -> bool

impl Service

pub async fn is_left(&self, user_id: &UserId, room_id: &RoomId) -> bool

impl Service

pub async fn delete_room_join_counts( &self, room_id: &RoomId, force: bool, ) -> Result

Trait Implementations

impl Service for Service

fn build(args: &Args<'_>) -> Result<Arc<Self>>

Implement the construction of the service instance. Services are generally singletons so expect this to only be called once for a service type. Note that it may be called again after a server reload, but the prior instance will have been dropped first. Failure will shutdown the server with an error.

fn name(&self) -> &str

Return the name of the service. i.e. crate::service::make_name(std::module_path!())

fn worker<'async_trait>( self: Arc<Self>, ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait,

Implement the service’s worker loop. The service manager spawns a task and calls this function after all services have been built.

fn interrupt<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Interrupt the service. This is sent to initiate a graceful shutdown. The service worker should return from its work loop.

fn clear_cache<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Clear any caches or similar runtime state.

fn memory_usage<'life0, 'life1, 'async_trait>( &'life0 self, _out: &'life1 mut (dyn Write + Send), ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

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

Memory usage report in a markdown string.

fn unconstrained(&self) -> bool

Return true if the service worker opts out of the tokio cooperative budgeting. This can reduce tail latency at the risk of event loop starvation.