File tree Expand file tree Collapse file tree 5 files changed +11
-11
lines changed Expand file tree Collapse file tree 5 files changed +11
-11
lines changed Original file line number Diff line number Diff line change @@ -22,7 +22,7 @@ impl PcrBank {
22
22
/// # Details
23
23
/// The order of pcr slots are assumed to match the order of the Digests.
24
24
///
25
- /// # Error
25
+ /// # Errors
26
26
/// - If number of pcr slots does not match the number of pcr digests
27
27
/// InconsistentParams error is returned.
28
28
///
@@ -88,7 +88,7 @@ impl PcrBank {
88
88
89
89
/// Inserts [Digest] value associated with a [PcrSlot] into the bank.
90
90
///
91
- /// # Error
91
+ /// # Errors
92
92
/// Returns an error if a [Digest] is already associated with the
93
93
/// provided [PcrSlot].
94
94
pub fn insert_digest ( & mut self , pcr_slot : PcrSlot , digest : Digest ) -> Result < ( ) > {
@@ -99,7 +99,7 @@ impl PcrBank {
99
99
100
100
/// Attempts to extend the [PcrBank] with `other`.
101
101
///
102
- /// # Error
102
+ /// # Errors
103
103
/// Returns an error if the a value in `other` already
104
104
/// exists.
105
105
pub fn try_extend ( & mut self , other : PcrBank ) -> Result < ( ) > {
Original file line number Diff line number Diff line change @@ -38,7 +38,7 @@ impl LocalityAttributes {
38
38
39
39
/// Returns the LocalityAttributes as a number.
40
40
///
41
- /// # Error
41
+ /// # Errors
42
42
/// If the attributes are not extended en InvalidParams error
43
43
/// is returned.
44
44
pub fn as_extended ( & self ) -> Result < u8 > {
Original file line number Diff line number Diff line change @@ -50,7 +50,7 @@ impl HandleManager {
50
50
51
51
/// Sets the handle as flushed which removes it from the manager.
52
52
///
53
- /// # Error
53
+ /// # Errors
54
54
/// If the handle was not set to be flushed then this will cause an
55
55
/// error but the handle will still be removed from the handler.
56
56
pub fn set_as_flushed ( & mut self , handle : ObjectHandle ) -> Result < ( ) > {
@@ -75,7 +75,7 @@ impl HandleManager {
75
75
76
76
/// Sets the handles as closed which removes it from the handler.
77
77
///
78
- /// # Error
78
+ /// # Errors
79
79
/// If the handle was set to be flushed then this will cause an
80
80
/// error but the handle will still be removed from the handler.
81
81
pub fn set_as_closed ( & mut self , handle : ObjectHandle ) -> Result < ( ) > {
Original file line number Diff line number Diff line change @@ -20,7 +20,7 @@ pub struct PcrSelection {
20
20
impl PcrSelection {
21
21
/// Creates new PcrSelection
22
22
///
23
- /// # Error
23
+ /// # Errors
24
24
/// Returns InconsistentParams error if a pcr slot
25
25
/// has been provided that ends up in an octet outside the
26
26
/// range specified by the `size_of_select` parameter.
@@ -65,7 +65,7 @@ impl PcrSelection {
65
65
66
66
/// Removes the specified [PcrSlot]s from the selected pcrs.
67
67
///
68
- /// # Error
68
+ /// # Errors
69
69
/// If one of the specified pcr slots does not exist in the selected pcrs.
70
70
pub fn deselect_exact ( & mut self , pcr_slot : PcrSlot ) -> Result < ( ) > {
71
71
self . pcr_slot_collection . remove_exact ( pcr_slot)
@@ -88,7 +88,7 @@ impl PcrSelection {
88
88
/// * Cannot be called with `other`that contains pcr slots present
89
89
/// in `self`.
90
90
///
91
- /// # Error
91
+ /// # Errors
92
92
/// Returns InvalidParam if there is a hashing algorithm mismatch
93
93
/// Returns InvalidParam if there is size of select mismatch.
94
94
/// Returns InvalidParam if `other` contains items that are present in `self`
Original file line number Diff line number Diff line change @@ -567,7 +567,7 @@ impl SignatureScheme {
567
567
/// This is intended to provide the functionality of reading
568
568
/// from the ```anySig``` field in the TPMU_SIG_SCHEME union.
569
569
///
570
- /// # Error
570
+ /// # Errors
571
571
/// Returns an InvalidParam error if the trying to read from
572
572
/// SignatureScheme that is not a signing scheme.
573
573
pub fn signing_scheme ( & self ) -> Result < HashingAlgorithm > {
@@ -591,7 +591,7 @@ impl SignatureScheme {
591
591
/// This is intended to provide the functionality of writing
592
592
/// to the ```anySig``` field in the TPMU_SIG_SCHEME union.
593
593
///
594
- /// # Error
594
+ /// # Errors
595
595
/// Returns an InvalidParam error if the trying to read from
596
596
/// SignatureScheme that is not a signing scheme.
597
597
pub fn set_signing_scheme ( & mut self , hashing_algorithm : HashingAlgorithm ) -> Result < ( ) > {
You can’t perform that action at this time.
0 commit comments