nitrokey-rs/src, branch next

Rename *lock fields of the Config struct

2020-09-21T22:05:53Z

libnitrokey calls the configuration fields that set bindings for the Num Lock, Caps Lock and Scroll Lock keys numlock, capslock, scrolllock. Due to a typo, scrolllock with three l was renamed to scrollock with two l in nitrokey-rs. To make the field names easier to read (and type) and consistent with the typical names for these keys, this patch changes them to num_lock, caps_lock and scroll_lock. In the doc comments, we now use the spelling “Num Lock”, “Caps Lock” and “Scroll Lock”.

Fix dead links in Device documentation

2020-09-07T09:01:19Z

Fix link in User doc comment

2020-09-06T11:01:36Z

Make *Error, Model, DeviceWrapper non-exhaustive

2020-09-06T10:57:16Z

Previously, all enums defined by the nitrokey crate were exhaustive. This means that adding new variants to these enums is a breaking change. To make it possible to add new features to nitrokey-rs without breaking compatibility, this patch marks the Error, CommandError, CommunicationError, LibraryError, Model and DeviceWrapper enums as non-exhaustive.

Export the FirmwareVersion struct

2020-09-05T09:59:07Z

This patch adds the FirmwareVersion struct to the re-exports in lib.rs. Previosuly, nitrokey users where able to access FirmwareVersion values as part of the Status struct and the Device::get_firmware_version method but could not see its definition.

Use map_err(|_| x) instead of or_else(|_| Err(x))

2020-08-30T16:52:15Z

Remove custom source implementation for Error

2020-08-30T16:43:31Z

This patch removes the custom implementation of the source method of the std::error::Error trait for the error::Error type. This means that the default implementation is used that always returns None. The reason for this change is that we already print the error message of the source error in the Display implementation. This leads to a duplicated error message if both Display and source are checked, for example with anyhow’s error formatting. See this thread for more information: https://lists.sr.ht/~ireas/nitrokey-rs-dev/%3C6e0b4dc8-9059-a113-e98e-b49e52818c75%40posteo.net%3E

Ensure Error trait implementations

2020-07-08T21:03:02Z

The anyhow crate requires that error types are error::Error, Send, Sync and 'static. This patch implements a simple static assertion that our Error type implements these traits.

Remove Error::RandError variant

2020-07-08T21:02:56Z

Since we update rand_os to version 0.2 in commit 6c138eaa850c745b97b7e48a201db0cbaad8e1e0, the random number generation can no longer fail. Therefore the Error::RandError variant is no longer needed. As we did not want to break the public API, we still kept the RandError variant. This patch removes the RandError variant for good.

Remove sync::PoisonError from Error::PoisonError

2020-07-08T21:02:49Z

Previously, the Error::PoisonError contained the sync::PoisonError that caused the error. This is problematic as sync::PoisonError does not implement Send, making it impossible to use the Error enum with the anyhow crate. At the same time, storing the sync::PoisonError is not very useful. If a user wants to access the poisoned lock, they can call the force_take function. Therefore we remove the sync::PoisonError value from the Error:: PoisonError variant. This also allows us to simplify the From> and From> implementations as we no longer need to know the type of the mutex that caused the error. For more information, see this thread: https://lists.sr.ht/~ireas/nitrokey-rs-dev/%3C68ed0f3f-d98f-63bc-04d2-81b6d6cde560%40posteo.net%3E