Struct InviteFilter 

pub struct InviteFilter {
    ignored: Option<IgnoredUserListEventContent>,
    stable: Option<InvitePermissionConfigEventContent>,
    unstable_blanket: Option<InvitePermissionConfigEventContent>,
    unstable_lists: Option<InvitePermissionConfigEventContent>,
}

A recipient’s invite filtering state, evaluable against any sender.

Holds the ignored-user list alongside every invite_permission_config account data slot a client may have written. The slots are read together once and then judged per sender, so a caller facing many invites pays for the account data once.

Fields

ignored: Option<IgnoredUserListEventContent>

stable: Option<InvitePermissionConfigEventContent>

unstable_blanket: Option<InvitePermissionConfigEventContent>

unstable_lists: Option<InvitePermissionConfigEventContent>

Implementations

impl InviteFilter

pub fn permits(&self, sender: Option<&UserId>) -> bool

Whether an invite from sender may be served to its recipient.

A sender of None means the stored invite state named no sender, which is a defect in what this server wrote rather than anything the recipient asked for, so every rule needing a sender falls open and the invite is served. The blanket block is decided without one and still applies, since the invite-permission module makes withholding those from sync a MUST.

impl InviteFilter

pub fn permission(&self, sender: &UserId) -> InvitePermission

The recipient’s verdict on an invite from sender.

A blanket block outranks everything, since the invite-permission module requires the 403 even when the sender is also on the ignore list. The ignored-user list comes next, then the rule lists slot by slot, and the first verdict other than allow wins.

impl InviteFilter

fn blocks_all(&self) -> bool

Whether the recipient accepts no invites at all.

Any slot carrying the blanket switch decides this, so a client writing one slot is never undone by another slot left behind.

impl InviteFilter

fn ignores(&self, sender: &UserId) -> bool

Whether the recipient ignores sender account-wide.

This is the ordinary m.ignored_user_list, which the invite-permission module defers to for everything short of a blanket block.

impl InviteFilter

pub fn is_permissive(&self) -> bool

Whether the recipient configured no filtering at all.

Callers on the sync path lean on this to skip deriving an invite’s sender, which costs a stripped-state load they would otherwise pay per room.

impl InviteFilter

fn configs( &self, ) -> impl Iterator<Item = &InvitePermissionConfigEventContent> + Send

The configuration slots in evaluation order.