turnkey/openpgp-card
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add a comment about the interaction between CardTransaction::init_card_caps and CardTransaction::initialize

Browse source
This commit is contained in:
Heiko Schaefer 2023-04-13 18:07:02 +02:00
parent a85d3164d7
commit 629eecd510
No known key found for this signature in database
GPG key ID: 4A849A1904CCBD7D
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
openpgp-card/src/lib.rs
View file

@ -70,7 +70,11 @@ pub trait CardTransaction {
/// Set the card capabilities in the CardTransaction. /// Set the card capabilities in the CardTransaction.
/// ///
/// Setting these capabilities is typically part of a bootstrapping /// Setting these capabilities is typically part of a bootstrapping
/// process: the information about the card's capabilities is typically /// process (this fn is typically called from [CardTransaction::initialize].
/// When implementing CardTransaction, you probably want to call
/// [CardTransaction::initialize] during setup).
///
/// The information about the card's capabilities is typically
/// requested from the card using the same CardTransaction instance, /// requested from the card using the same CardTransaction instance,
/// before the card's capabilities have been initialized. /// before the card's capabilities have been initialized.
fn init_card_caps(&mut self, caps: CardCaps); fn init_card_caps(&mut self, caps: CardCaps);