Struct RequestedRequiredStates

pub struct RequestedRequiredStates { /* private fields */ }

Represent the required_state values sent by a sync request.

This is useful to track what state events have been requested when handling a response.

For example, if a sync requests the m.room.encryption state event, and the server replies with nothing, if means the room is not encrypted. Without knowing which state event was required by the sync, it is impossible to interpret the absence of state event from the server as the room’s encryption state is not encrypted or the room’s encryption state is unknown.

Implementations

impl RequestedRequiredStates

pub fn new( default: Vec<(StateEventType, String)>, for_rooms: HashMap<OwnedRoomId, Vec<(StateEventType, String)>>, ) -> Self

Create a new RequestedRequiredStates.

default represents the required_state value for all rooms. for_rooms is the required_state per room.

pub fn for_room(&self, room_id: &RoomId) -> &[(StateEventType, String)]

Get the required_state value for a specific room.

Trait Implementations

impl Debug for RequestedRequiredStates

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

Formats the value using the given formatter.

impl Default for RequestedRequiredStates

fn default() -> RequestedRequiredStates

Returns the “default value” for a type.

impl From<&Request> for RequestedRequiredStates

fn from(request: &Request) -> Self

Converts to this type from the input type.