pub struct RoomPowerLevels {
    pub ban: Int,
    pub events: BTreeMap<TimelineEventType, Int>,
    pub events_default: Int,
    pub invite: Int,
    pub kick: Int,
    pub redact: Int,
    pub state_default: Int,
    pub users: BTreeMap<OwnedUserId, Int>,
    pub users_default: Int,
    pub notifications: NotificationPowerLevels,
}
Available on crate feature events only.
Expand description

The effective power levels of a room.

This struct contains the same fields as RoomPowerLevelsEventContent and be created from that using a From trait implementation, but it is also implements From<RedactedRoomPowerLevelsEventContent>, so can be used when wanting to inspect the power levels of a room, regardless of whether the most recent power-levels event is redacted or not.

Fields§

§ban: Int

The level required to ban a user.

§events: BTreeMap<TimelineEventType, Int>

The level required to send specific event types.

This is a mapping from event type to power level required.

§events_default: Int

The default level required to send message events.

§invite: Int

The level required to invite a user.

§kick: Int

The level required to kick a user.

§redact: Int

The level required to redact an event.

§state_default: Int

The default level required to send state events.

§users: BTreeMap<OwnedUserId, Int>

The power levels for specific users.

This is a mapping from user_id to power level for that user.

§users_default: Int

The default power level for every user in the room.

§notifications: NotificationPowerLevels

The power level requirements for specific notification types.

This is a mapping from key to power level for that notifications key.

Implementations§

source§

impl RoomPowerLevels

source

pub fn for_user(&self, user_id: &UserId) -> Int

Get the power level of a specific user.

source

pub fn for_action(&self, action: PowerLevelAction) -> Int

Get the power level required to perform a given action.

source

pub fn for_message(&self, msg_type: MessageLikeEventType) -> Int

Get the power level required to send the given message type.

source

pub fn for_state(&self, state_type: StateEventType) -> Int

Get the power level required to send the given state event type.

source

pub fn user_can_ban(&self, user_id: &UserId) -> bool

Whether the given user can ban other users based on the power levels.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::Ban).

source

pub fn user_can_ban_user( &self, acting_user_id: &UserId, target_user_id: &UserId ) -> bool

Whether the acting user can ban the target user based on the power levels.

On top of power_levels.user_can_ban(acting_user_id), this performs an extra check to make sure the acting user has at greater power level than the target user.

Shorthand for power_levels.user_can_do_to_user(acting_user_id, target_user_id, PowerLevelUserAction::Ban).

source

pub fn user_can_unban(&self, user_id: &UserId) -> bool

Whether the given user can unban other users based on the power levels.

This action requires to be allowed to ban and to kick.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::Unban).

source

pub fn user_can_unban_user( &self, acting_user_id: &UserId, target_user_id: &UserId ) -> bool

Whether the acting user can unban the target user based on the power levels.

This action requires to be allowed to ban and to kick.

On top of power_levels.user_can_unban(acting_user_id), this performs an extra check to make sure the acting user has at greater power level than the target user.

Shorthand for power_levels.user_can_do_to_user(acting_user_id, target_user_id, PowerLevelUserAction::Unban).

source

pub fn user_can_invite(&self, user_id: &UserId) -> bool

Whether the given user can invite other users based on the power levels.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::Invite).

source

pub fn user_can_kick(&self, user_id: &UserId) -> bool

Whether the given user can kick other users based on the power levels.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::Kick).

source

pub fn user_can_kick_user( &self, acting_user_id: &UserId, target_user_id: &UserId ) -> bool

Whether the acting user can kick the target user based on the power levels.

On top of power_levels.user_can_kick(acting_user_id), this performs an extra check to make sure the acting user has at least the same power level as the target user.

Shorthand for power_levels.user_can_do_to_user(acting_user_id, target_user_id, PowerLevelUserAction::Kick).

source

pub fn user_can_redact_own_event(&self, user_id: &UserId) -> bool

Whether the given user can redact their own events based on the power levels.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::RedactOwn).

source

pub fn user_can_redact_event_of_other(&self, user_id: &UserId) -> bool

Whether the given user can redact events of other users based on the power levels.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::RedactOthers).

source

pub fn user_can_send_message( &self, user_id: &UserId, msg_type: MessageLikeEventType ) -> bool

Whether the given user can send message events based on the power levels.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::SendMessage(msg_type)).

source

pub fn user_can_send_state( &self, user_id: &UserId, state_type: StateEventType ) -> bool

Whether the given user can send state events based on the power levels.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::SendState(state_type)).

source

pub fn user_can_trigger_room_notification(&self, user_id: &UserId) -> bool

Whether the given user can notify everybody in the room by writing @room in a message.

Shorthand for power_levels.user_can_do(user_id, PowerLevelAction::TriggerNotification(NotificationPowerLevelType::Room)).

source

pub fn user_can_change_user_power_level( &self, acting_user_id: &UserId, target_user_id: &UserId ) -> bool

Whether the acting user can change the power level of the target user.

Shorthand for power_levels.user_can_do_to_user(acting_user_id, target_user_id, PowerLevelUserAction::ChangePowerLevel.

source

pub fn user_can_do(&self, user_id: &UserId, action: PowerLevelAction) -> bool

Whether the given user can do the given action based on the power levels.

source

pub fn user_can_do_to_user( &self, acting_user_id: &UserId, target_user_id: &UserId, action: PowerLevelUserAction ) -> bool

Whether the acting user can do the given action to the target user based on the power levels.

source

pub fn max(&self) -> Int

Get the maximum power level of any user.

Trait Implementations§

source§

impl Clone for RoomPowerLevels

source§

fn clone(&self) -> RoomPowerLevels

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RoomPowerLevels

source§

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

Formats the value using the given formatter. Read more
source§

impl From<RedactedRoomPowerLevelsEventContent> for RoomPowerLevels

source§

fn from(c: RedactedRoomPowerLevelsEventContent) -> RoomPowerLevels

Converts to this type from the input type.
source§

impl From<RoomPowerLevels> for PushConditionPowerLevelsCtx

source§

fn from(c: RoomPowerLevels) -> PushConditionPowerLevelsCtx

Converts to this type from the input type.
source§

impl From<RoomPowerLevels> for RoomPowerLevelsEventContent

source§

fn from(c: RoomPowerLevels) -> RoomPowerLevelsEventContent

Converts to this type from the input type.
source§

impl From<RoomPowerLevelsEventContent> for RoomPowerLevels

source§

fn from(c: RoomPowerLevelsEventContent) -> RoomPowerLevels

Converts to this type from the input type.

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<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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