milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

document alternate formatting

This commit is contained in:
Riccardo Casatta 2021-04-09 18:24:27 +02:00
parent bc406bfdd6
commit 3158cedea0
No known key found for this signature in database
GPG Key ID: FD986A969E450397
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/util/address.rs
View File

@ -354,10 +354,14 @@ impl Address {
} }
/// Creates a string optimized to be encoded in QR codes, meaning it becomes uppercase if bech32. /// Creates a string optimized to be encoded in QR codes, meaning it becomes uppercase if bech32.
///
/// Quoting BIP 173 "inside QR codes uppercase SHOULD be used, as those permit the use of /// Quoting BIP 173 "inside QR codes uppercase SHOULD be used, as those permit the use of
/// alphanumeric mode, which is 45% more compact than the normal byte mode." /// alphanumeric mode, which is 45% more compact than the normal byte mode."
/// Even inside Bitcoin URI may be more efficient to use the uppercase address since in QR codes /// Even inside Bitcoin URI may be more efficient to use the uppercase address since in QR codes
/// encoding modes can be mixed as needed within a QR symbol. /// encoding modes can be mixed as needed within a QR symbol.
///
/// This `fn` is a shorthand of the alternate formatting `{:#}` which should be preferred in most
/// cases because it avoids the [String] allocation.
pub fn to_qr_string(&self) -> String { pub fn to_qr_string(&self) -> String {
format!("{:#}", self) format!("{:#}", self)
} }