summaryrefslogtreecommitdiffstats
path: root/openpgp/src/packet_pile.rs
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2022-06-09 12:05:42 +0200
committerJustus Winter <justus@sequoia-pgp.org>2024-01-22 13:05:38 +0100
commit96d829d681ea1b860bf4b16439082929f4636147 (patch)
treedf23193f76319a0be62e0d2630d11157ce1a0da1 /openpgp/src/packet_pile.rs
parentf396703a0ca809ce6200d7cb009a9bc83dd6683a (diff)
openpgp: Rename every from_buffered_reader to from_cookie_reader.
- This is an internal interface that uses our reader stack's cookie. We need this to traverse the buffered reader stack. We did not, however, expose it as an external interface, because we didn't want to bake in the cookie type into the API. - Having a public API that operates on buffered readers is convenient: the current Parser::from_reader operates on io::Readers, and will most likely construct a buffered_reader::Generic from it. This will eagerly buffer some data, making this interface unsuitable if you want to read in one artifact (e.g. an MPI) without consuming more data. - Renaming the internal functions gives us a chance to add a more general buffered reader interface.
Diffstat (limited to 'openpgp/src/packet_pile.rs')
-rw-r--r--openpgp/src/packet_pile.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/openpgp/src/packet_pile.rs b/openpgp/src/packet_pile.rs
index fe45e736..f62eb6f6 100644
--- a/openpgp/src/packet_pile.rs
+++ b/openpgp/src/packet_pile.rs
@@ -136,7 +136,7 @@ impl<'a> Parse<'a, PacketPile> for PacketPile {
fn from_reader<R: 'a + io::Read + Send + Sync>(reader: R) -> Result<PacketPile> {
let bio = buffered_reader::Generic::with_cookie(
reader, None, Cookie::default());
- PacketPile::from_buffered_reader(Box::new(bio))
+ PacketPile::from_cookie_reader(Box::new(bio))
}
/// Deserializes the OpenPGP message stored in the file named by
@@ -144,7 +144,7 @@ impl<'a> Parse<'a, PacketPile> for PacketPile {
///
/// See `from_reader` for more details and caveats.
fn from_file<P: AsRef<Path>>(path: P) -> Result<PacketPile> {
- PacketPile::from_buffered_reader(
+ PacketPile::from_cookie_reader(
Box::new(buffered_reader::File::with_cookie(path, Cookie::default())?))
}
@@ -154,7 +154,7 @@ impl<'a> Parse<'a, PacketPile> for PacketPile {
fn from_bytes<D: AsRef<[u8]> + ?Sized>(data: &'a D) -> Result<PacketPile> {
let bio = buffered_reader::Memory::with_cookie(
data.as_ref(), Cookie::default());
- PacketPile::from_buffered_reader(Box::new(bio))
+ PacketPile::from_cookie_reader(Box::new(bio))
}
}
@@ -504,9 +504,9 @@ impl PacketPile {
}
- pub(crate) fn from_buffered_reader<'a>(bio: Box<dyn BufferedReader<Cookie> + 'a>)
+ pub(crate) fn from_cookie_reader<'a>(bio: Box<dyn BufferedReader<Cookie> + 'a>)
-> Result<PacketPile> {
- PacketParserBuilder::from_buffered_reader(bio)?
+ PacketParserBuilder::from_cookie_reader(bio)?
.buffer_unread_content()
.into_packet_pile()
}