Struct Service 

pub struct Service {
    services: Arc<OnceServices>,
    eventid_originalpdu: Arc<Map>,
    timeredacted_eventid: Arc<Map>,
}

Stores and expires the unredacted originals of redacted events.

Each retained event has a primary row and a time-ordered expiry index row. The background worker removes entries once their configured retention interval has elapsed.

Fields

services: Arc<OnceServices>

eventid_originalpdu: Arc<Map>

timeredacted_eventid: Arc<Map>

Implementations

impl Service

pub async fn get_original_pdu(&self, event_id: &EventId) -> Result<PduEvent>

Returns a retained original decoded as a PDU.

Missing rows and malformed stored JSON are reported to the caller.

impl Service

pub async fn get_original_pdu_json( &self, event_id: &EventId, ) -> Result<CanonicalJsonObject>

Returns a retained original as canonical event JSON.

Missing rows and malformed stored JSON are reported to the caller.

impl Service

pub async fn save_original_pdu( &self, event_id: &EventId, pdu: &CanonicalJsonObject, _state_lock: &RoomMutexGuard, )

Retains an event’s original JSON before it is redacted.

Saving is skipped when saving originals is disabled or an original already exists. The primary row and its redaction-time expiry index are committed in one transaction while the caller retains the room timeline guard.

impl Service

fn insert_original( &self, event_id: &EventId, pdu: &CanonicalJsonObject, time: u64, )

Writes a retained original and its expiry index atomically.

The supplied timestamp is the redaction time used by the cleanup worker.

impl Service

pub fn retained_pdus_raw(&self) -> impl Stream<Item = Result<&[u8]>> + Send

Streams the raw JSON values of all retained originals.

Values borrow the database cursor and must be owned before they are retained across another poll. Storage errors remain in the stream.

impl Service

pub fn purge_original(&self, event_id: &EventId)

Drops the retained original of a purged event.

The paired expiry-index row is deliberately left for the retention worker to reap at its scheduled time.

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 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 name(&self) -> &str

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

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.