diff options
author | Robin Krahl <robin.krahl@ireas.org> | 2020-01-11 20:13:22 +0100 |
---|---|---|
committer | Robin Krahl <robin.krahl@ireas.org> | 2020-01-11 20:26:40 +0100 |
commit | 6142752da1563c1ab873dc7069aeec72522cca99 (patch) | |
tree | bb6fe9eca8cbd5e32d4b133b57d90466c4bc9b8e /src/device/mod.rs | |
parent | dbee55efa41496c8a683bfab96163facc93d6639 (diff) | |
download | nitrokey-rs-6142752da1563c1ab873dc7069aeec72522cca99.tar.gz nitrokey-rs-6142752da1563c1ab873dc7069aeec72522cca99.tar.bz2 |
Rename Status::get_status to get_storage_status
In the last patch, we added the get_status function to the Device trait.
This patch renames the Storage::get_status function to
get_storage_status to resolve the name clash – though allowed by the
compiler, it is rather confusing for the end user.
Diffstat (limited to 'src/device/mod.rs')
-rw-r--r-- | src/device/mod.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/device/mod.rs b/src/device/mod.rs index 668c230..ef9f018 100644 --- a/src/device/mod.rs +++ b/src/device/mod.rs @@ -230,7 +230,7 @@ pub trait Device<'a>: Authenticate<'a> + GetPasswordSafe<'a> + GenerateOtp + fmt /// /// This methods returns the status information common to all Nitrokey devices as a /// [`Status`][] struct. Some models may provide more information, for example - /// [`Storage::get_status`][] returns the [`StorageStatus`][] struct. + /// [`get_storage_status`][] returns the [`StorageStatus`][] struct. /// /// # Errors /// @@ -249,9 +249,9 @@ pub trait Device<'a>: Authenticate<'a> + GetPasswordSafe<'a> + GenerateOtp + fmt /// # Ok::<(), nitrokey::Error>(()) /// ``` /// + /// [`get_storage_status`]: struct.Storage.html#method.get_storage_status /// [`NotConnected`]: enum.CommunicationError.html#variant.NotConnected /// [`Status`]: struct.Status.html - /// [`Storage::get_status`]: struct.Storage.html#method.get_status /// [`StorageStatus`]: struct.StorageStatus.html fn get_status(&self) -> Result<Status, Error>; |