diff options
author | Justus Winter <justus@sequoia-pgp.org> | 2018-06-20 10:13:45 +0200 |
---|---|---|
committer | Justus Winter <justus@sequoia-pgp.org> | 2018-06-20 10:15:24 +0200 |
commit | b76921eb851cbe1c895b4545726e9984d5181036 (patch) | |
tree | 7ab9fcdbe4f4fee328cb23b6ae36f7ecc10213ae /ffi | |
parent | 420c2aecc0beeb58d2ea0f2b8e9fc8d00275ffba (diff) |
openpgp: Fix 99d0dbe486e0fdd1e1b9cf266f93a726abcf2444.
Diffstat (limited to 'ffi')
-rw-r--r-- | ffi/include/sequoia/openpgp.h | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/ffi/include/sequoia/openpgp.h b/ffi/include/sequoia/openpgp.h index c83fef5b..51da1d77 100644 --- a/ffi/include/sequoia/openpgp.h +++ b/ffi/include/sequoia/openpgp.h @@ -167,61 +167,61 @@ sq_reader_t sq_armor_reader_new (sq_reader_t inner, sq_armor_kind_t kind); sq_writer_t sq_armor_writer_new (sq_writer_t inner, sq_armor_kind_t kind); -/* openpgp::Message. */ +/* openpgp::PacketPile. */ /*/ -/// A `Message` holds a deserialized OpenPGP message. +/// A `PacketPile` holds a deserialized OpenPGP message. /*/ -typedef struct sq_message *sq_message_t; +typedef struct sq_packet_pile *sq_packet_pile_t; /*/ /// Deserializes the OpenPGP message stored in a `std::io::Read` /// object. /// /// Although this method is easier to use to parse an OpenPGP -/// message than a `PacketParser` or a `MessageParser`, this -/// interface buffers the whole message in memory. Thus, the -/// caller must be certain that the *deserialized* message is not +/// packet pile than a `PacketParser` or a `PacketPileParser`, this +/// interface buffers the whole packet pile in memory. Thus, the +/// caller must be certain that the *deserialized* packet pile is not /// too large. /// /// Note: this interface *does* buffer the contents of packets. /*/ -sq_message_t sq_message_from_reader (sq_context_t ctx, - sq_reader_t reader); +sq_packet_pile_t sq_packet_pile_from_reader (sq_context_t ctx, + sq_reader_t reader); /*/ -/// Deserializes the OpenPGP message stored in the file named by +/// Deserializes the OpenPGP packet pile stored in the file named by /// `filename`. /// -/// See `sq_message_from_reader` for more details and caveats. +/// See `sq_packet_pile_from_reader` for more details and caveats. /*/ -sq_message_t sq_message_from_file (sq_context_t ctx, - const char *filename); +sq_packet_pile_t sq_packet_pile_from_file (sq_context_t ctx, + const char *filename); /*/ -/// Deserializes the OpenPGP message stored in the provided buffer. +/// Deserializes the OpenPGP packet pile stored in the provided buffer. /// -/// See `sq_message_from_reader` for more details and caveats. +/// See `sq_packet_pile_from_reader` for more details and caveats. /*/ -sq_message_t sq_message_from_bytes (sq_context_t ctx, - const uint8_t *b, size_t len); +sq_packet_pile_t sq_packet_pile_from_bytes (sq_context_t ctx, + const uint8_t *b, size_t len); /*/ -/// Frees the message. +/// Frees the packet pile. /*/ -void sq_message_free (sq_message_t message); +void sq_packet_pile_free (sq_packet_pile_t message); /*/ -/// Clones the Message. +/// Clones the packet pile. /*/ -sq_message_t sq_message_clone (sq_message_t message); +sq_packet_pile_t sq_packet_pile_clone (sq_packet_pile_t message); /*/ -/// Serializes the message. +/// Serializes the packet pile. /*/ -sq_status_t sq_message_serialize (sq_context_t ctx, - const sq_message_t message, - sq_writer_t writer); +sq_status_t sq_packet_pile_serialize (sq_context_t ctx, + const sq_packet_pile_t message, + sq_writer_t writer); /* openpgp::tpk. */ @@ -254,13 +254,13 @@ sq_tpk_t sq_tpk_from_file (sq_context_t ctx, /// /// Consumes `m`. /*/ -sq_tpk_t sq_tpk_from_message (sq_context_t ctx, - sq_message_t m); +sq_tpk_t sq_tpk_from_packet_pile (sq_context_t ctx, + sq_packet_pile_t m); /*/ /// Returns the first TPK found in `buf`. /// -/// `buf` must be an OpenPGP encoded message. +/// `buf` must be an OpenPGP-encoded TPK. /*/ sq_tpk_t sq_tpk_from_bytes (sq_context_t ctx, const uint8_t *b, size_t len); |