Struct Service 

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

Fields

services: Arc<OnceServices>

db: Db

Implementations

impl Service

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

Remove the entry for room_id from the cache.

impl Service

pub(super) fn cache_put( &self, room_id: &RoomId, summary: Option<&ParentSummary>, )

impl Service

pub(super) async fn cache_get(&self, room_id: &RoomId) -> Result<Cached>

impl Service

fn generate_ttl(&self) -> SystemTime

impl Service

pub(super) async fn get_summary_and_children_federation( &self, current_room: &RoomId, sender: &Identifier<'_>, via: &[OwnedServerName], ) -> Result<Accessibility>

Gets the summary of a space using solely federation.

impl Service

pub(super) async fn get_summary_and_children_local( &self, current_room: &RoomId, sender: &Identifier<'_>, ) -> Result<Accessibility>

Gets the summary of a space using solely local information.

impl Service

pub(super) async fn get_room_summary( &self, room_id: &RoomId, children_state: Vec<Raw<HierarchySpaceChildEvent>>, sender: &Identifier<'_>, ) -> Result<Accessibility, Error>

impl Service

pub async fn get_summary_and_children( &self, room_id: &RoomId, sender: &Identifier<'_>, via: &[OwnedServerName], ) -> Result<Accessibility>

Gets the summary of a space using either local or remote (federation) sources

impl Service

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

Simply returns the stripped m.space.child events of a room

impl Service

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

Simply returns the stripped m.space.child events of a room

impl Service

async fn is_accessible_child( &self, current_room: &RoomId, join_rule: &JoinRuleSummary, sender: &Identifier<'_>, ) -> bool

With the given identifier, checks if a room is accessible

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 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 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 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.