Skip to main content

Homeserver

Struct Homeserver 

Source
pub struct Homeserver {
Show 16 fields pub db: Db, pub readers: OnceLock<ReadPool>, pub live: LiveRegistry, pub typing: TypingRegistry, pub claim_rate: ClaimRateLimiter, pub push: PushHub, pub public_base_url: OnceLock<String>, pub federation_delegate: OnceLock<String>, pub federation_enabled: OnceLock<()>, pub federation_allow: OnceLock<Vec<String>>, pub anon_read: OnceLock<()>, pub key_fetcher: OnceLock<Arc<dyn RemoteKeys>>, pub fed_transport: OnceLock<Arc<dyn FedTransport>>, pub fed_notify: Notify, pub seam: OnceLock<Arc<Seam>>, pub policy: OnceLock<Arc<dyn PolicyHook>>,
}

Fields§

§db: Db

The store: one writer, bounded parallel readers (tesserax-store). Reach it through Homeserver::conn_scope (blocking threads) or [with_conn_pub] (async).

§readers: OnceLock<ReadPool>

Parallel read-only connections (file-backed stores only; None for in-memory stores).

§live: LiveRegistry§typing: TypingRegistry§claim_rate: ClaimRateLimiter§push: PushHub§public_base_url: OnceLock<String>

Public client base URL for /.well-known/matrix/client (config, never hard-coded).

§federation_delegate: OnceLock<String>

m.server value for /.well-known/matrix/server; unset = federation off.

§federation_enabled: OnceLock<()>

Federation F0 switch: when set, the key and federation routes answer.

§federation_allow: OnceLock<Vec<String>>

Origins allowed to call federation routes; unset = any origin that proves its keys.

§anon_read: OnceLock<()>

Set (M4A_ANON_READ=on) to honour the product’s marked, assertion-less read-only forwards.

§key_fetcher: OnceLock<Arc<dyn RemoteKeys>>

How remote servers’ signing keys are fetched; unset = no remote verification.

§fed_transport: OnceLock<Arc<dyn FedTransport>>

Outgoing federation transport; unset = no outgoing federation.

§fed_notify: Notify

Wakes the outbox worker when new federation work exists.

§seam: OnceLock<Arc<Seam>>

Accounts, doors and issuer assertions; unset = legacy device-bearer behaviour only.

§policy: OnceLock<Arc<dyn PolicyHook>>

Policy hook; unset = allow everything.

Implementations§

Source§

impl Homeserver

Source

pub fn new(conn: Connection) -> Self

A store over an already-open in-memory connection (tests, the client’s local bus). File-backed stores come from Homeserver::from_db.

Source

pub fn from_db(db: Db) -> Self

A store over an opened tesserax-store writer.

Source

pub fn check_policy( &self, caller: &Caller, action: Action, room_kind: Option<RoomKind>, ) -> Result<(), MatrixError>

Ask the policy hook (default: allow) about an action by caller.

Source§

impl Homeserver

Source

pub async fn conn_async<T: Send + 'static>( &self, f: impl FnOnce(&mut Connection) -> T + Send + 'static, ) -> T

Runs f on the single writer connection, waiting for it. For blocking threads only (spawn_blocking, plain threads); async code uses [with_conn_pub]. Async form of Homeserver::conn_scope (runs on the blocking pool).

Source

pub fn conn_scope<T>(&self, f: impl FnOnce(&mut Connection) -> T) -> T

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more