Struct ruma_common::events::room::server_acl::RoomServerAclEventContent

#[non_exhaustive]
pub struct RoomServerAclEventContent {
    pub allow_ip_literals: bool,
    pub allow: Vec<String>,
    pub deny: Vec<String>,
}

The content of an m.room.server_acl event.

An event to indicate which servers are permitted to participate in the room.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_ip_literals: bool

Whether to allow server names that are IP address literals.

This is strongly recommended to be set to false as servers running with IP literal names are strongly discouraged in order to require legitimate homeservers to be backed by a valid registered domain name.

allow: Vec<String>

The server names to allow in the room, excluding any port information.

Wildcards may be used to cover a wider range of hosts, where * matches zero or more characters and ? matches exactly one character.

Defaults to an empty list when not provided, effectively disallowing every server.

deny: Vec<String>

The server names to disallow in the room, excluding any port information.

Wildcards may be used to cover a wider range of hosts, where * matches zero or more characters and ? matches exactly one character.

Defaults to an empty list when not provided.

Implementations

impl RoomServerAclEventContent

pub fn new(
    allow_ip_literals: bool,
    allow: Vec<String>,
    deny: Vec<String>
) -> Self

Creates a new RoomServerAclEventContent with the given IP literal allowance flag, allowed and denied servers.

pub fn is_allowed(&self, server_name: &ServerName) -> bool

Returns true if and only if the server is allowed by the ACL rules.

Trait Implementations

impl Clone for RoomServerAclEventContent

fn clone(&self) -> RoomServerAclEventContent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoomServerAclEventContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomServerAclEventContent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomServerAclEventContent

type EventType = StateEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> Self::EventType

Get the event’s type, like m.room.message.

impl From<RoomServerAclEventContent> for AnyStateEventContent

fn from(c: RoomServerAclEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for RoomServerAclEventContent

type Redacted = RedactedRoomServerAclEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedRoomServerAclEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for RoomServerAclEventContent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StateEventContent for RoomServerAclEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl StaticEventContent for RoomServerAclEventContent

const KIND: EventKind = ::ruma_common::events::EventKind::State{redacted: false,}

The event’s “kind”.

const TYPE: &'static str = "m.room.server_acl"

The event type.