From fdc8aeaa53c33c97c8d871b80ee4b040ee96e213 Mon Sep 17 00:00:00 2001 From: oupson Date: Thu, 6 Oct 2022 17:06:34 +0200 Subject: [PATCH] Document GocryptFs --- rustcryptfs-lib/src/lib.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rustcryptfs-lib/src/lib.rs b/rustcryptfs-lib/src/lib.rs index 7aa6eca..ff50e00 100644 --- a/rustcryptfs-lib/src/lib.rs +++ b/rustcryptfs-lib/src/lib.rs @@ -1,4 +1,4 @@ -//! A library to write gocryptfs compatible programs +//! A library to write gocryptfs compatible programs. use std::{fs::File, path::Path}; @@ -45,10 +45,12 @@ impl GocryptFs { }) } - pub fn filename_decoder<'s> (&'s self) -> &'s FilenameDecoder { + /// Get the [`filename decoder`](struct@FilenameDecoder) attached to this GocryptFs. + pub fn filename_decoder<'s>(&'s self) -> &'s FilenameDecoder { &self.filename_decoder } + /// Get the [`content decoder`](struct@ContentEnc) attached to this GocryptFs. pub fn content_decoder(&self) -> &ContentEnc { &self.content_decoder }