Skip to content

Commit 16564cf

Browse files
committed
Changes Error to Errors in documentation.
Signed-off-by: Jesper Brynolf <[email protected]>
1 parent c3fb7d6 commit 16564cf

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

tss-esapi/src/abstraction/pcr/bank.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ impl PcrBank {
2222
/// # Details
2323
/// The order of pcr slots are assumed to match the order of the Digests.
2424
///
25-
/// # Error
25+
/// # Errors
2626
/// - If number of pcr slots does not match the number of pcr digests
2727
/// InconsistentParams error is returned.
2828
///
@@ -88,7 +88,7 @@ impl PcrBank {
8888

8989
/// Inserts [Digest] value associated with a [PcrSlot] into the bank.
9090
///
91-
/// # Error
91+
/// # Errors
9292
/// Returns an error if a [Digest] is already associated with the
9393
/// provided [PcrSlot].
9494
pub fn insert_digest(&mut self, pcr_slot: PcrSlot, digest: Digest) -> Result<()> {
@@ -99,7 +99,7 @@ impl PcrBank {
9999

100100
/// Attempts to extend the [PcrBank] with `other`.
101101
///
102-
/// # Error
102+
/// # Errors
103103
/// Returns an error if the a value in `other` already
104104
/// exists.
105105
pub fn try_extend(&mut self, other: PcrBank) -> Result<()> {

tss-esapi/src/attributes/locality.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ impl LocalityAttributes {
3838

3939
/// Returns the LocalityAttributes as a number.
4040
///
41-
/// # Error
41+
/// # Errors
4242
/// If the attributes are not extended en InvalidParams error
4343
/// is returned.
4444
pub fn as_extended(&self) -> Result<u8> {

tss-esapi/src/context/handle_manager.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ impl HandleManager {
5050

5151
/// Sets the handle as flushed which removes it from the manager.
5252
///
53-
/// # Error
53+
/// # Errors
5454
/// If the handle was not set to be flushed then this will cause an
5555
/// error but the handle will still be removed from the handler.
5656
pub fn set_as_flushed(&mut self, handle: ObjectHandle) -> Result<()> {
@@ -75,7 +75,7 @@ impl HandleManager {
7575

7676
/// Sets the handles as closed which removes it from the handler.
7777
///
78-
/// # Error
78+
/// # Errors
7979
/// If the handle was set to be flushed then this will cause an
8080
/// error but the handle will still be removed from the handler.
8181
pub fn set_as_closed(&mut self, handle: ObjectHandle) -> Result<()> {

tss-esapi/src/structures/pcr/selection.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pub struct PcrSelection {
2020
impl PcrSelection {
2121
/// Creates new PcrSelection
2222
///
23-
/// # Error
23+
/// # Errors
2424
/// Returns InconsistentParams error if a pcr slot
2525
/// has been provided that ends up in an octet outside the
2626
/// range specified by the `size_of_select` parameter.
@@ -65,7 +65,7 @@ impl PcrSelection {
6565

6666
/// Removes the specified [PcrSlot]s from the selected pcrs.
6767
///
68-
/// # Error
68+
/// # Errors
6969
/// If one of the specified pcr slots does not exist in the selected pcrs.
7070
pub fn deselect_exact(&mut self, pcr_slot: PcrSlot) -> Result<()> {
7171
self.pcr_slot_collection.remove_exact(pcr_slot)
@@ -88,7 +88,7 @@ impl PcrSelection {
8888
/// * Cannot be called with `other`that contains pcr slots present
8989
/// in `self`.
9090
///
91-
/// # Error
91+
/// # Errors
9292
/// Returns InvalidParam if there is a hashing algorithm mismatch
9393
/// Returns InvalidParam if there is size of select mismatch.
9494
/// Returns InvalidParam if `other` contains items that are present in `self`

tss-esapi/src/structures/tagged/schemes.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ impl SignatureScheme {
567567
/// This is intended to provide the functionality of reading
568568
/// from the ```anySig``` field in the TPMU_SIG_SCHEME union.
569569
///
570-
/// # Error
570+
/// # Errors
571571
/// Returns an InvalidParam error if the trying to read from
572572
/// SignatureScheme that is not a signing scheme.
573573
pub fn signing_scheme(&self) -> Result<HashingAlgorithm> {
@@ -591,7 +591,7 @@ impl SignatureScheme {
591591
/// This is intended to provide the functionality of writing
592592
/// to the ```anySig``` field in the TPMU_SIG_SCHEME union.
593593
///
594-
/// # Error
594+
/// # Errors
595595
/// Returns an InvalidParam error if the trying to read from
596596
/// SignatureScheme that is not a signing scheme.
597597
pub fn set_signing_scheme(&mut self, hashing_algorithm: HashingAlgorithm) -> Result<()> {

0 commit comments

Comments
 (0)