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

Add clearer docs to auth_check

Browse Source
This commit is contained in:
Devin Ragotzy 2021-01-12 08:29:39 -05:00
parent 47b19fdc15
commit 37bff47a8e
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/event_auth.rs
View File

@ -71,6 +71,9 @@ pub fn auth_types_for_event(
/// The `auth_events` that are passed to this function should be a state snapshot. /// The `auth_events` that are passed to this function should be a state snapshot.
/// We need to know if the event passes auth against some state not a recursive collection /// We need to know if the event passes auth against some state not a recursive collection
/// of auth_events fields. /// of auth_events fields.
///
/// ## Returns
/// This returns an `Error` only when serialization fails or some other fatal outcome.
pub fn auth_check<E: Event>( pub fn auth_check<E: Event>(
room_version: &RoomVersionId, room_version: &RoomVersionId,
incoming_event: &Arc<E>, incoming_event: &Arc<E>,