chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update resolve methods docs for event_map

Browse Source
This commit is contained in:
Devin Ragotzy 2021-01-13 15:38:27 -05:00 committed by Devin Ragotzy
parent 37bff47a8e
commit d7144e63b7
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib.rs
View File

@ -83,12 +83,7 @@ impl StateResolution {
/// * `auth_events` - The full recursive set of `auth_events` for each event in the `state_sets`. /// * `auth_events` - The full recursive set of `auth_events` for each event in the `state_sets`.
/// ///
/// * `event_map` - The `EventMap` acts as a local cache of state, any event that is not found /// * `event_map` - The `EventMap` acts as a local cache of state, any event that is not found
/// in the `event_map` will be fetched from the `StateStore` and cached in the `event_map`. There /// in the `event_map` will cause an unrecoverable `Error` in `resolve`.
/// is no state kept from separate `resolve` calls, although this could be a potential optimization
/// in the future.
///
/// It is up the the caller to check that the events returned from `StateStore::get_event` are
/// events for the correct room (synapse checks that all events are in the right room).
pub fn resolve<E: Event>( pub fn resolve<E: Event>(
room_id: &RoomId, room_id: &RoomId,
room_version: &RoomVersionId, room_version: &RoomVersionId,