Trait Reader

Source

pub trait Reader<'r>: Clone {
    const CAN_READ_SLICE: bool;
Show 22 methods
    // Required methods
    fn encoding_rules(&self) -> EncodingRules;
    fn input_len(&self) -> Length;
    fn position(&self) -> Length;
    fn read_nested<T, F, E>(&mut self, len: Length, f: F) -> Result<T, E>
       where E: From<Error>,
             F: FnOnce(&mut Self) -> Result<T, E>;
    fn read_slice(&mut self, len: Length) -> Result<&'r [u8], Error>;

    // Provided methods
    fn context_specific<T>(
        &mut self,
        tag_number: TagNumber,
        tag_mode: TagMode,
    ) -> Result<Option<T>, T::Error>
       where T: DecodeValue<'r> + FixedTag + 'r { ... }
    fn decode<T: Decode<'r>>(&mut self) -> Result<T, T::Error> { ... }
    fn drain(&mut self, amount: Length) -> Result<(), Error> { ... }
    fn error(&mut self, kind: ErrorKind) -> Error { ... }
    fn finish(self) -> Result<(), Error> { ... }
    fn is_finished(&self) -> bool { ... }
    fn offset(&self) -> Length { ... }
    fn peek_byte(&self) -> Option<u8> { ... }
    fn peek_into(&self, buf: &mut [u8]) -> Result<(), Error> { ... }
    fn peek_header(&self) -> Result<Header, Error> { ... }
    fn peek_tag(&self) -> Result<Tag, Error> { ... }
    fn read_byte(&mut self) -> Result<u8, Error> { ... }
    fn read_into<'o>(&mut self, buf: &'o mut [u8]) -> Result<&'o [u8], Error> { ... }
    fn read_vec(&mut self, len: Length) -> Result<Vec<u8>, Error> { ... }
    fn remaining_len(&self) -> Length { ... }
    fn sequence<F, T, E>(&mut self, f: F) -> Result<T, E>
       where F: FnOnce(&mut Self) -> Result<T, E>,
             E: From<Error> { ... }
    fn tlv_bytes(&mut self) -> Result<&'r [u8], Error> { ... }
}

Expand description

Reader trait which reads DER-encoded input.

Required Associated Constants§

Source

const CAN_READ_SLICE: bool

Does this reader support the read_slice method? (i.e. can it borrow from his input?)

Required Methods§

Source

fn encoding_rules(&self) -> EncodingRules

Get the EncodingRules which should be applied when decoding the input.

Source

fn input_len(&self) -> Length

Get the length of the input.

Source

fn position(&self) -> Length

Get the position within the buffer.

Source

fn read_nested<T, F, E>(&mut self, len: Length, f: F) -> Result<T, E>
where E: From<Error>, F: FnOnce(&mut Self) -> Result<T, E>,

Read nested data of the given length.

§Errors

If f returns an error.

Source

fn read_slice(&mut self, len: Length) -> Result<&'r [u8], Error>

Attempt to read data borrowed directly from the input as a slice, updating the internal cursor position.

§Errors

Err(ErrorKind::Incomplete) if there is not enough data
Err(ErrorKind::Reader) if the reader can’t borrow from the input

Provided Methods§

Source

fn context_specific<T>( &mut self, tag_number: TagNumber, tag_mode: TagMode, ) -> Result<Option<T>, T::Error>
where T: DecodeValue<'r> + FixedTag + 'r,

Attempt to decode an ASN.1 CONTEXT-SPECIFIC field with the provided TagNumber.

§Errors

If a decoding error occurred.

Source

fn decode<T: Decode<'r>>(&mut self) -> Result<T, T::Error>

Decode a value which impls the Decode trait.

§Errors

Returns T::Error if a decoding error occurred.

Source

fn drain(&mut self, amount: Length) -> Result<(), Error>

Drain the given amount of data from the reader, discarding it.

§Errors

If an error occurred reading the given amount of data.

Source

fn error(&mut self, kind: ErrorKind) -> Error

Return an error with the given ErrorKind, annotating it with context about where the error occurred.

Source

fn finish(self) -> Result<(), Error>

Finish decoding, returning Ok(()) if there is no remaining data, or an error otherwise.

§Errors

If there is trailing data remaining in the reader.

Source

fn is_finished(&self) -> bool

Have we read all input data?

Source

fn offset(&self) -> Length

Offset within the original input stream.

This is used for error reporting, and doesn’t need to be overridden by any reader implementations (except for the built-in NestedReader, which consumes nested input messages)

Source