@@ -56,7 +56,7 @@ use crate::{
5656 } ,
5757} ;
5858
59- // TODO add creation times to the inbound group sessions so we can export
59+ // TODO: add creation times to the inbound group sessions so we can export
6060// sessions that were created between some time period, this should only be set
6161// for non-imported sessions.
6262
@@ -210,23 +210,17 @@ impl InboundGroupSession {
210210 } )
211211 }
212212
213- /// Create a InboundGroupSession from an exported version of the group
214- /// session.
213+ /// Create a new [` InboundGroupSession`] from an exported version of the
214+ /// group session.
215215 ///
216- /// Most notably this can be called with an `ExportedRoomKey` from a
217- /// previous [`export()`] call.
218- ///
219- /// [`export()`]: #method.export
216+ /// Most notably this can be called with an [`ExportedRoomKey`] from a
217+ /// previous [`InboundGroupSession::export()`] call.
220218 pub fn from_export ( exported_session : & ExportedRoomKey ) -> Result < Self , SessionCreationError > {
221219 Self :: try_from ( exported_session)
222220 }
223221
224- /// Store the group session as a base64 encoded string.
225- ///
226- /// # Arguments
227- ///
228- /// * `pickle_mode` - The mode that was used to pickle the group session,
229- /// either an unencrypted mode or an encrypted using passphrase.
222+ /// Convert the [`InboundGroupSession`] into a
223+ /// [`PickledInboundGroupSession`] which can be serialized.
230224 pub async fn pickle ( & self ) -> PickledInboundGroupSession {
231225 let pickle = self . inner . lock ( ) . await . pickle ( ) ;
232226
@@ -246,7 +240,7 @@ impl InboundGroupSession {
246240 /// Export this session at the first known message index.
247241 ///
248242 /// If only a limited part of this session should be exported use
249- /// [`export_at_index()`](#method.export_at_index) .
243+ /// [`InboundGroupSession:: export_at_index()`].
250244 pub async fn export ( & self ) -> ExportedRoomKey {
251245 self . export_at_index ( self . first_known_index ( ) ) . await
252246 }
0 commit comments