Struct sequoia_openpgp::parse::Cookie

pub struct Cookie { /* private fields */ }

Private state used by the PacketParser.

This is not intended to be used. It is possible to explicitly create Cookie instances using its Default implementation for low-level interfacing with parsing code.

Trait Implementations

impl BufferedReader<Cookie> for Reader<'_>

fn buffer(&self) -> &[u8]

Returns a reference to the internal buffer.

fn data(&mut self, amount: usize) -> Result<&[u8]>

Ensures that the internal buffer has at least amount bytes of data, and returns it.

fn data_hard(&mut self, amount: usize) -> Result<&[u8]>

Like BufferedReader::data, but returns an error if there is not at least amount bytes available.

fn consume(&mut self, amount: usize) -> &[u8]

Consumes some of the data.

fn data_consume(&mut self, amount: usize) -> Result<&[u8]>

A convenience function that combines BufferedReader::data and BufferedReader::consume.

fn data_consume_hard(&mut self, amount: usize) -> Result<&[u8]>

A convenience function that effectively combines BufferedReader::data_hard and BufferedReader::consume.

fn get_mut(&mut self) -> Option<&mut dyn BufferedReader<Cookie>>

Returns a mutable reference to the inner BufferedReader, if any.

fn get_ref(&self) -> Option<&dyn BufferedReader<Cookie>>

Returns a reference to the inner BufferedReader, if any.

fn into_inner<'b>(
    self: Box<Self>
) -> Option<Box<dyn BufferedReader<Cookie> + 'b>> where
    Self: 'b, 

Returns the underlying reader, if any.

fn cookie_set(&mut self, cookie: Cookie) -> Cookie

Sets the BufferedReader’s cookie and returns the old value.

fn cookie_ref(&self) -> &Cookie

Returns a reference to the BufferedReader’s cookie.

fn cookie_mut(&mut self) -> &mut Cookie

Returns a mutable reference to the BufferedReader’s cookie.

fn data_eof(&mut self) -> Result<&[u8], Error>

Returns all of the data until EOF. Like BufferedReader::data, this does not actually consume the data that is read.

fn eof(&mut self) -> bool

Checks whether the end of the stream is reached.

fn consummated(&mut self) -> bool

Checks whether this reader is consummated.

fn read_be_u16(&mut self) -> Result<u16, Error>

A convenience function for reading a 16-bit unsigned integer in big endian format.

fn read_be_u32(&mut self) -> Result<u32, Error>

A convenience function for reading a 32-bit unsigned integer in big endian format.

fn read_to(&mut self, terminal: u8) -> Result<&[u8], Error>

Reads until either terminal is encountered or EOF.

fn drop_until(&mut self, terminals: &[u8]) -> Result<usize, Error>

Discards the input until one of the bytes in terminals is encountered.

fn drop_through(
    &mut self,
    terminals: &[u8],
    match_eof: bool
) -> Result<(Option<u8>, usize), Error>

Discards the input until one of the bytes in terminals is encountered.

fn steal(&mut self, amount: usize) -> Result<Vec<u8, Global>, Error>

Like BufferedReader::data_consume_hard, but returns the data in a caller-owned buffer.

fn steal_eof(&mut self) -> Result<Vec<u8, Global>, Error>

Like BufferedReader::steal, but instead of stealing a fixed number of bytes, steals all of the data until the end of file.

fn drop_eof(&mut self) -> Result<bool, Error>

Like BufferedReader::steal_eof, but instead of returning the data, the data is discarded.

fn copy(&mut self, sink: &mut dyn Write) -> Result<u64, Error>

Copies data to the given writer returning the copied amount.

fn dump(&self, sink: &mut dyn Write) -> Result<(), Error>

A helpful debugging aid to pretty print a Buffered Reader stack.

fn into_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a, Global> where
    Self: 'a, 

Boxes the reader.

fn as_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a, Global> where
    Self: 'a, 

👎 Deprecated:

Use into_boxed

Boxes the reader.

impl<'a> BufferedReader<Cookie> for PacketParser<'a>

This interface allows a caller to read the content of a PacketParser using the BufferedReader interface. This is essential to supporting streaming operation.

Note: it is safe to mix the use of the std::io::Read and BufferedReader interfaces.

fn buffer(&self) -> &[u8]

Returns a reference to the internal buffer.

fn data(&mut self, amount: usize) -> Result<&[u8]>

Ensures that the internal buffer has at least amount bytes of data, and returns it.

fn data_hard(&mut self, amount: usize) -> Result<&[u8]>

Like BufferedReader::data, but returns an error if there is not at least amount bytes available.

fn data_eof(&mut self) -> Result<&[u8]>

Returns all of the data until EOF. Like BufferedReader::data, this does not actually consume the data that is read.

fn consume(&mut self, amount: usize) -> &[u8]

Consumes some of the data.

fn data_consume(&mut self, amount: usize) -> Result<&[u8]>

A convenience function that combines BufferedReader::data and BufferedReader::consume.

fn data_consume_hard(&mut self, amount: usize) -> Result<&[u8]>

A convenience function that effectively combines BufferedReader::data_hard and BufferedReader::consume.

fn steal(&mut self, amount: usize) -> Result<Vec<u8>>

Like BufferedReader::data_consume_hard, but returns the data in a caller-owned buffer.

fn steal_eof(&mut self) -> Result<Vec<u8>>

Like BufferedReader::steal, but instead of stealing a fixed number of bytes, steals all of the data until the end of file.

fn get_mut(&mut self) -> Option<&mut dyn BufferedReader<Cookie>>

Returns a mutable reference to the inner BufferedReader, if any.

fn get_ref(&self) -> Option<&dyn BufferedReader<Cookie>>

Returns a reference to the inner BufferedReader, if any.

fn into_inner<'b>(
    self: Box<Self>
) -> Option<Box<dyn BufferedReader<Cookie> + 'b>> where
    Self: 'b, 

Returns the underlying reader, if any.

fn cookie_set(&mut self, cookie: Cookie) -> Cookie

Sets the BufferedReader’s cookie and returns the old value.

fn cookie_ref(&self) -> &Cookie

Returns a reference to the BufferedReader’s cookie.

fn cookie_mut(&mut self) -> &mut Cookie

Returns a mutable reference to the BufferedReader’s cookie.

fn eof(&mut self) -> bool

Checks whether the end of the stream is reached.

fn consummated(&mut self) -> bool

Checks whether this reader is consummated.

fn read_be_u16(&mut self) -> Result<u16, Error>

A convenience function for reading a 16-bit unsigned integer in big endian format.

fn read_be_u32(&mut self) -> Result<u32, Error>

A convenience function for reading a 32-bit unsigned integer in big endian format.

fn read_to(&mut self, terminal: u8) -> Result<&[u8], Error>

Reads until either terminal is encountered or EOF.

fn drop_until(&mut self, terminals: &[u8]) -> Result<usize, Error>

Discards the input until one of the bytes in terminals is encountered.

fn drop_through(
    &mut self,
    terminals: &[u8],
    match_eof: bool
) -> Result<(Option<u8>, usize), Error>

Discards the input until one of the bytes in terminals is encountered.

fn drop_eof(&mut self) -> Result<bool, Error>

Like BufferedReader::steal_eof, but instead of returning the data, the data is discarded.

fn copy(&mut self, sink: &mut dyn Write) -> Result<u64, Error>

Copies data to the given writer returning the copied amount.

fn dump(&self, sink: &mut dyn Write) -> Result<(), Error>

A helpful debugging aid to pretty print a Buffered Reader stack.

fn into_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a, Global> where
    Self: 'a, 

Boxes the reader.

fn as_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a, Global> where
    Self: 'a, 

👎 Deprecated:

Use into_boxed

Boxes the reader.

impl Debug for Cookie

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Cookie

fn default() -> Self

Returns the “default value” for a type.