Struct sequoia_openpgp::parse::Cookie

source ·
pub struct Cookie { /* private fields */ }
Expand description

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§

source§

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.

source§

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

Returns a reference to the internal buffer. Read more
source§

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

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

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. Read more
source§

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. Read more
source§

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

Consumes some of the data. Read more
source§

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

A convenience function that combines BufferedReader::data and BufferedReader::consume. Read more
source§

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

A convenience function that effectively combines BufferedReader::data_hard and BufferedReader::consume. Read more
source§

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

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

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.
source§

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

Returns a mutable reference to the inner BufferedReader, if any. Read more
source§

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

Returns a reference to the inner BufferedReader, if any.
source§

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

Returns the underlying reader, if any. Read more
source§

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

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

fn cookie_ref(&self) -> &Cookie

Returns a reference to the BufferedReader’s cookie.
source§

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

Returns a mutable reference to the BufferedReader’s cookie.
source§

fn eof(&mut self) -> bool

Checks whether the end of the stream is reached.
source§

fn consummated(&mut self) -> bool

Checks whether this reader is consummated. Read more
source§

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

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

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

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

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

Reads until either terminal is encountered or EOF. Read more
source§

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

Discards the input until one of the bytes in terminals is encountered. Read more
source§

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. Read more
source§

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

Like BufferedReader::steal_eof, but instead of returning the data, the data is discarded. Read more
source§

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

Copies data to the given writer returning the copied amount. Read more
source§

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

A helpful debugging aid to pretty print a Buffered Reader stack. Read more
source§

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

Boxes the reader.
source§

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

👎Deprecated: Use into_boxed
Boxes the reader.
source§

impl BufferedReader<Cookie> for Reader<'_>

source§

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

Returns a reference to the internal buffer. Read more
source§

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

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

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. Read more
source§

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

Consumes some of the data. Read more
source§

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

A convenience function that combines BufferedReader::data and BufferedReader::consume. Read more
source§

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

A convenience function that effectively combines BufferedReader::data_hard and BufferedReader::consume. Read more
source§

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

Returns a mutable reference to the inner BufferedReader, if any. Read more
source§

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

Returns a reference to the inner BufferedReader, if any.
source§

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

Returns the underlying reader, if any. Read more
source§

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

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

fn cookie_ref(&self) -> &Cookie

Returns a reference to the BufferedReader’s cookie.
source§

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

Returns a mutable reference to the BufferedReader’s cookie.
source§

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. Read more
source§

fn eof(&mut self) -> bool

Checks whether the end of the stream is reached.
source§

fn consummated(&mut self) -> bool

Checks whether this reader is consummated. Read more
source§

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

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

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

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

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

Reads until either terminal is encountered or EOF. Read more
source§

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

Discards the input until one of the bytes in terminals is encountered. Read more
source§

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. Read more
source§

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

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

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

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

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

Like BufferedReader::steal_eof, but instead of returning the data, the data is discarded. Read more
source§

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

Copies data to the given writer returning the copied amount. Read more
source§

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

A helpful debugging aid to pretty print a Buffered Reader stack. Read more
source§

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

Boxes the reader.
source§

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

👎Deprecated: Use into_boxed
Boxes the reader.
source§

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

Formats the value using the given formatter. Read more
source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.