mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-05 22:47:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc(crypto): Document all the arguments of the InboundGroupSession::new method

Browse Source
This commit is contained in:
Damir Jelić
2025-02-25 16:14:45 +01:00
parent c1e28aa156
commit ea073f55f0
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
crates/matrix-sdk-crypto/src/olm/group_sessions/inbound.rs
View File

@@ -183,6 +183,23 @@ impl InboundGroupSession {
///
/// * `sender_data` - Information about the sender of the to-device message
/// that established this session.
///
/// * `encryption_algorithm` - The [`EventEncryptionAlgorithm`] that should
/// be used when messages are being decrypted. The method will return an
/// [`SessionCreationError::Algorithm`] error if an algorithm we do not
/// support is given,
///
/// * `history_visibility` - The history visibility of the room at the time
/// the matching [`OutboundGroupSession`] was created. This is only set if
/// we are the crator of this [`InboundGroupSession`]. Sessinons that are
/// received from other devices use the `shared_history` flag instead.
///
/// * `shared_history` - Whether this [`InboundGroupSession`] can be shared
/// with users who are invited to the room in the future, allowing access
/// to history, as defined in [MSC3061]. This flag is a surjection of the
/// history visibility of the room.
///
/// [MSC3061]: https://github.com/matrix-org/matrix-spec-proposals/pull/3061
#[allow(clippy::too_many_arguments)]
pub fn new(
sender_key: Curve25519PublicKey,