aboutsummaryrefslogtreecommitdiff
path: root/src/auth.rs
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2019-01-27 19:52:53 +0000
committerRobin Krahl <robin.krahl@ireas.org>2019-07-09 10:44:08 +0200
commit62e8ee8f5d02511d6eb5dc179b087b04e88c1b94 (patch)
tree910e7fcae5b2b502900c67782b4db22d9c242f21 /src/auth.rs
parent0ac9c401c9968d39581fe2bc3a6610cb9a7a22d8 (diff)
downloadnitrokey-rs-62e8ee8f5d02511d6eb5dc179b087b04e88c1b94.tar.gz
nitrokey-rs-62e8ee8f5d02511d6eb5dc179b087b04e88c1b94.tar.bz2
Update documentation for Manager refactoring
This patch updates the documentation to reflect the latest changes to connection handling. It also updates the doc tests to prefer the new methods over the old ones.
Diffstat (limited to 'src/auth.rs')
-rw-r--r--src/auth.rs13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/auth.rs b/src/auth.rs
index 829d083..0b000f7 100644
--- a/src/auth.rs
+++ b/src/auth.rs
@@ -39,11 +39,12 @@ pub trait Authenticate<'a> {
/// use nitrokey::{Authenticate, DeviceWrapper, User};
/// # use nitrokey::Error;
///
- /// fn perform_user_task(device: &User<DeviceWrapper>) {}
+ /// fn perform_user_task<'a>(device: &User<'a, DeviceWrapper<'a>>) {}
/// fn perform_other_task(device: &DeviceWrapper) {}
///
/// # fn try_main() -> Result<(), Error> {
- /// let device = nitrokey::connect()?;
+ /// let mut manager = nitrokey::take()?;
+ /// let device = manager.connect()?;
/// let device = match device.authenticate_user("123456") {
/// Ok(user) => {
/// perform_user_task(&user);
@@ -85,11 +86,12 @@ pub trait Authenticate<'a> {
/// use nitrokey::{Authenticate, Admin, DeviceWrapper};
/// # use nitrokey::Error;
///
- /// fn perform_admin_task(device: &Admin<DeviceWrapper>) {}
+ /// fn perform_admin_task<'a>(device: &Admin<'a, DeviceWrapper<'a>>) {}
/// fn perform_other_task(device: &DeviceWrapper) {}
///
/// # fn try_main() -> Result<(), Error> {
- /// let device = nitrokey::connect()?;
+ /// let mut manager = nitrokey::take()?;
+ /// let device = manager.connect()?;
/// let device = match device.authenticate_admin("123456") {
/// Ok(admin) => {
/// perform_admin_task(&admin);
@@ -291,7 +293,8 @@ impl<'a, T: Device<'a>> Admin<'a, T> {
/// # use nitrokey::Error;
///
/// # fn try_main() -> Result<(), Error> {
- /// let device = nitrokey::connect()?;
+ /// let mut manager = nitrokey::take()?;
+ /// let device = manager.connect()?;
/// let config = Config::new(None, None, None, false);
/// match device.authenticate_admin("12345678") {
/// Ok(mut admin) => {