Struct Service 

pub struct Service {
    db: Data,
    services: Arc<OnceServices>,
}

Provides room inventory and local moderation metadata.

The service combines short-room and timeline indexes with directory and join-rule state, plus persistent disabled and banned marker maps.

Fields

db: Data

services: Arc<OnceServices>

Implementations

impl Service

pub async fn exists(&self, room_id: &RoomId) -> bool

Reports whether at least one timeline PDU is stored for a room.

A room without a short ID is absent. Database scan errors are skipped, so a failed or empty scan also returns false.

impl Service

pub fn public_ids_prefix<'a>( &'a self, prefix: &'a str, ) -> impl Stream<Item = OwnedRoomId> + Send + 'a

Streams public room IDs whose encoded IDs begin with a prefix.

IDs are owned before the asynchronous public-room check. Invalid index rows are skipped, and public means directory-listed or governed by a public join rule.

impl Service

pub fn ids_prefix<'a>( &'a self, prefix: &'a str, ) -> impl Stream<Item = &RoomId> + Send + 'a

Streams indexed room IDs whose encoded IDs begin with a prefix.

Each borrowed ID is valid only until the stream is polled again and must be copied before retention. Unparsable rows are skipped.

impl Service

pub fn iter_ids(&self) -> impl Stream<Item = &RoomId> + Send + '_

Streams every room ID present in the short-room-ID index.

Indexed rooms need not still contain timeline events. Each borrowed ID is valid only until the next poll, and unparsable rows are skipped.

impl Service

pub async fn is_public(&self, room_id: &RoomId) -> bool

Reports whether a room is publicly discoverable or joinable.

An explicit directory listing or a valid public join rule is sufficient. Missing or invalid join-rule state falls back to invite and does not grant access.

impl Service

pub fn disable_room(&self, room_id: &RoomId)

Disables inbound federation processing for a room.

The persistent marker is independent of the room’s banned status and may be written before the server has stored the room.

impl Service

pub fn enable_room(&self, room_id: &RoomId)

Re-enables inbound federation processing for a room.

Removing the disabled marker does not alter any banned marker for the room.

impl Service

pub fn ban_room(&self, room_id: &RoomId)

Bans a room without recording a responsible user.

The empty marker overwrites any previously stored blocker attribution. A room may be banned before any of its events are stored locally.

impl Service

pub fn unban_room(&self, room_id: &RoomId)

Removes a room’s local ban marker.

Unbanning does not re-enable federation if the independent disabled marker remains present.

impl Service

pub fn block_room(&self, room_id: &RoomId, blocker: &UserId)

Bans a room and records the user responsible for the block.

The user ID replaces any existing empty or attributed ban value. The room need not otherwise exist locally.

impl Service

pub async fn banned_room_blocker(&self, room_id: &RoomId) -> Option<OwnedUserId>

Returns the user attributed to a room’s ban marker.

Empty legacy or unattributed markers, invalid user IDs, missing rows, and database errors all yield None; use Self::is_banned to test the marker.

impl Service

pub fn list_banned_rooms(&self) -> impl Stream<Item = &RoomId> + Send + '_

Streams every room with a local ban marker.

Each borrowed room ID is valid only until the stream is polled again and must be copied before retention. Unparsable rows are skipped.

impl Service

pub async fn is_disabled(&self, room_id: &RoomId) -> bool

Reports whether a room has a disabled marker.

Missing rows and database errors both return false.

impl Service

pub async fn is_banned(&self, room_id: &RoomId) -> bool

Reports whether a room has a banned marker.

Both empty bans and user-attributed blocks count. Missing rows and database errors return false.

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.