Skip to content

Commit 522bf52

Browse files
committed
rxrpc, trusted: add missing docstrings
1 parent da67307 commit 522bf52

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

src/keytypes/rxrpc.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
2525
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2626

27+
//! Keys for RxRPC clients.
28+
2729
use std::borrow::Cow;
2830

2931
use keytype::*;
@@ -42,6 +44,7 @@ impl KeyType for RxRPC {
4244
}
4345
}
4446

47+
/// The payload for RxRPC client keys.
4548
#[derive(Debug, Clone, PartialEq, Eq)]
4649
pub struct Payload {
4750
expiry: u32,

src/keytypes/trusted.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ impl KeyType for Trusted {
4747
}
4848
}
4949

50+
/// Hashes supported by TPM devices.
5051
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
5152
pub enum TpmHash {
5253
/// SHA-1
@@ -81,6 +82,7 @@ impl TpmHash {
8182
}
8283
}
8384

85+
/// Options for trusted keys.
8486
#[derive(Debug, Default, Clone, PartialEq, Eq)]
8587
pub struct TrustedOptions {
8688
/// The ID of the sealing key to use.
@@ -177,6 +179,7 @@ impl TrustedOptions {
177179
}
178180
}
179181

182+
/// The payload for trusted keys.
180183
#[derive(Debug, Clone, PartialEq, Eq)]
181184
pub enum Payload {
182185
/// Create a new key.
@@ -200,7 +203,10 @@ pub enum Payload {
200203
/// Update a key.
201204
///
202205
/// Use this with `update`.
203-
Update { options: TrustedOptions },
206+
Update {
207+
/// Options to apply to the key.
208+
options: TrustedOptions,
209+
},
204210
}
205211

206212
impl KeyPayload for Payload {

0 commit comments

Comments
 (0)