Struct Decoder

pub struct Decoder<'i> { /* private fields */ }

Buffered PEM decoder.

Stateful buffered decoder type which decodes an input PEM document according to RFC 7468’s “Strict” grammar.

Implementations

impl<'i> Decoder<'i>

pub fn new(pem: &'i [u8]) -> Result<Self>

Create a new PEM Decoder with the default options.

Uses the default 64-character line wrapping.

pub fn new_wrapped(pem: &'i [u8], line_width: usize) -> Result<Self>

Create a new PEM Decoder which wraps at the given line width.

pub fn type_label(&self) -> &'i str

Get the PEM type label for the input document.

pub fn decode<'o>(&mut self, buf: &'o mut [u8]) -> Result<&'o [u8]>

Decode data into the provided output buffer.

There must be at least as much remaining Base64 input to be decoded in order to completely fill buf.

pub fn decode_to_end<'o>(&mut self, buf: &'o mut Vec<u8>) -> Result<&'o [u8]>

Available on crate feature alloc only.

Decode all of the remaining data in the input buffer into buf.

pub fn remaining_len(&self) -> usize

Get the decoded length of the remaining PEM data after Base64 decoding.

pub fn is_finished(&self) -> bool

Are we finished decoding the PEM input?

Trait Implementations

impl<'i> Clone for Decoder<'i>

fn clone(&self) -> Decoder<'i>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'i> From<Decoder<'i>> for Base64Decoder<'i>

fn from(decoder: Decoder<'i>) -> Base64Decoder<'i>

Converts to this type from the input type.

impl<'i> Read for Decoder<'i>

Available on crate feature std only.

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Reads all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Reads the exact number of bytes required to fill buf.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.