Struct SyncResponseBuilder

pub struct SyncResponseBuilder { /* private fields */ }

The SyncResponseBuilder struct can be used to easily generate valid sync responses for testing. These can be then fed into either Client or Room.

It supports generated a number of canned events, such as a member entering a room, his power level and display name changing and similar. It also supports insertion of custom events in the form of EventsJson values.

Implementations

impl SyncResponseBuilder

pub fn new() -> Self

pub fn add_joined_room(&mut self, room: JoinedRoomBuilder) -> &mut Self

Add a joined room to the next sync response.

If a room with the same room ID already exists, it is replaced by this one.

pub fn add_invited_room(&mut self, room: InvitedRoomBuilder) -> &mut Self

Add an invited room to the next sync response.

If a room with the same room ID already exists, it is replaced by this one.

pub fn add_left_room(&mut self, room: LeftRoomBuilder) -> &mut Self

Add a left room to the next sync response.

If a room with the same room ID already exists, it is replaced by this one.

pub fn add_presence_event(&mut self, event: PresenceTestEvent) -> &mut Self

Add a presence event.

pub fn add_presence_bulk<I>(&mut self, events: I) -> &mut Self

where I: IntoIterator<Item = Raw<PresenceEvent>>,

Add presence in bulk.

pub fn add_global_account_data_event( &mut self, event: GlobalAccountDataTestEvent, ) -> &mut Self

Add global account data.

pub fn add_global_account_data_bulk<I>(&mut self, events: I) -> &mut Self

where I: IntoIterator<Item = Raw<AnyGlobalAccountDataEvent>>,

Add global account data in bulk.

pub fn build_json_sync_response(&mut self) -> JsonValue

Builds a sync response as a JSON Value containing the events we queued so far.

The next response returned by build_sync_response will then be empty if no further events were queued.

This method is raw JSON equivalent to build_sync_response(), use build_sync_response() if you need a typed response.

pub fn build_sync_response(&mut self) -> SyncResponse

Builds a SyncResponse containing the events we queued so far.

The next response returned by build_sync_response will then be empty if no further events were queued.

This method is high level and typed equivalent to build_json_sync_response(), use build_json_sync_response() if you need an untyped response.

pub fn clear(&mut self)

Trait Implementations

impl Default for SyncResponseBuilder

fn default() -> SyncResponseBuilder

Returns the “default value” for a type.