pretty_good/
lib.rs

1//! # pretty-good overview
2//!
3//! pretty-good is an implementation of RFC4880 (OpenPGP Message Format), capable of reading
4//! OpenPGP packets into usable Rust structures, and creating and writing OpenPGP packets
5//! programmatically in Rust.
6//!
7//! The primary structure of pretty-good is the [`Packet`] enum, which contains a variant for each
8//! possible type of OpenPGP packet. Each variant that has been implemented contains a single
9//! field, which is a structure representing the contents of that packet type. For example,
10//! `Packet::Signature` contains a [`SignaturePacket`], which can be used to read and write OpenPGP
11//! signatures.
12//!
13//! [`Packet`]s are read by calling [`Packet::from_bytes`], and can be serialized by calling
14//! [`Packet::to_bytes`].
15//!
16//! [`Packet`]: enum.Packet.html
17//! [`Packet::to_bytes`]: enum.Packet.html#method.to_bytes
18//! [`Packet::from_bytes`]: enum.Packet.html#method.from_bytes
19//! [`SignaturePacket`]: struct.SignaturePacket.html
20extern crate byteorder;
21extern crate bzip2;
22extern crate digest;
23#[macro_use]
24extern crate failure;
25#[macro_use]
26extern crate failure_derive;
27extern crate flate2;
28extern crate md5;
29#[macro_use]
30extern crate nom;
31extern crate num;
32extern crate ripemd160;
33extern crate sha1;
34extern crate sha2;
35extern crate yasna;
36
37mod compression;
38mod key;
39mod literal;
40mod marker;
41mod packet;
42mod s2k;
43mod signature;
44mod types;
45mod userid;
46mod util;
47
48pub use compression::*;
49pub use key::*;
50pub use literal::*;
51pub use packet::*;
52pub use s2k::*;
53pub use signature::*;
54pub use types::*;