diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2020-07-27 16:04:25 +0200 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2020-07-27 16:04:25 +0200 |
| commit | f64940feff7fb8020c5cbd6d69c9eb28d61a8898 (patch) | |
| tree | a509050cfb5d3be20efbebd220cf79703333d497 /openpgp/src/parse.rs | |
| parent | 4c8ebb1883a438906ed990e022d7f54d45ba6cff (diff) | |
openpgp: Document parse::Dearmor.
- Fixes #471.
Diffstat (limited to 'openpgp/src/parse.rs')
| -rw-r--r-- | openpgp/src/parse.rs | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/openpgp/src/parse.rs b/openpgp/src/parse.rs index 835d5399..0bfa4e49 100644 --- a/openpgp/src/parse.rs +++ b/openpgp/src/parse.rs @@ -119,6 +119,16 @@ //! [`Decryptor`]: stream/struct.Decryptor.html //! [`Verifier`]: stream/struct.Verifier.html //! +//! # ASCII armored data +//! +//! The [`PacketParser`] will by default automatically detect and +//! remove any ASCII armor encoding (see [Section 6 of RFC 4880]). +//! This automatism can be disabled and fine-tuned using +//! [`PacketParserBuilder::dearmor`]. +//! +//! [Section 6 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-6 +//! [`PacketParserBuilder::dearmor`]: struct.PacketParserBuilder.html#method.dearmor +//! //! # Security Considerations //! //! In general, OpenPGP data must be considered attacker controlled |