Struct der::Document

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

ASN.1 DER-encoded document.

This type wraps an encoded ASN.1 DER message. The document checked to ensure it contains a valid DER-encoded SEQUENCE.

It implements common functionality related to encoding/decoding such documents, such as PEM encapsulation as well as reading/writing documents from/to the filesystem.

The SecretDocument provides a wrapper for this type with additional hardening applied.

Implementations§

source§

impl Document

source

pub fn as_bytes(&self) -> &[u8]

Get the ASN.1 DER-encoded bytes of this document.

source

pub fn into_secret(self) -> SecretDocument

Convert to a SecretDocument.

source

pub fn into_vec(self) -> Vec<u8>

Convert to an ASN.1 DER-encoded byte vector.

source

pub fn to_vec(&self) -> Vec<u8>

Return an ASN.1 DER-encoded byte vector.

source

pub fn len(&self) -> Length

Get the length of the encoded ASN.1 DER in bytes.

source

pub fn decode_msg<'a, T: Decode<'a>>(&'a self) -> Result<T>

Try to decode the inner ASN.1 DER message contained in this Document as the given type.

source

pub fn encode_msg<T: Encode>(msg: &T) -> Result<Self>

Encode the provided type as ASN.1 DER, storing the resulting encoded DER as a Document.

source

pub fn read_der_file(path: impl AsRef<Path>) -> Result<Self>

Read ASN.1 DER document from a file.

source

pub fn write_der_file(&self, path: impl AsRef<Path>) -> Result<()>

Write ASN.1 DER document to a file.

Trait Implementations§

source§

impl AsRef<[u8]> for Document

source§

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

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for Document

source§

fn clone(&self) -> Document

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Document

source§

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

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

impl<'a> Decode<'a> for Document

source§

fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Document>

Attempt to decode this message using the provided decoder.
source§

fn from_der(bytes: &'a [u8]) -> Result<Self>

Parse Self from the provided DER-encoded byte slice.
source§

impl Encode for Document

source§

fn encoded_len(&self) -> Result<Length>

Compute the length of this value in bytes when encoded as ASN.1 DER.
source§

fn encode(&self, writer: &mut impl Writer) -> Result<()>

Encode this value as ASN.1 DER using the provided Writer.
source§

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

Encode this value to the provided byte slice, returning a sub-slice containing the encoded message.
source§

fn encode_to_vec(&self, buf: &mut Vec<u8>) -> Result<Length>

Encode this message as ASN.1 DER, appending it to the provided byte vector.
source§

fn to_der(&self) -> Result<Vec<u8>>

Encode this type as DER, returning a byte vector.
source§

impl FixedTag for Document

source§

const TAG: Tag = Tag::Sequence

ASN.1 tag
source§

impl From<Document> for SecretDocument

source§

fn from(doc: Document) -> SecretDocument

Converts to this type from the input type.
source§

impl PartialEq for Document

source§

fn eq(&self, other: &Document) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl TryFrom<&[u8]> for Document

§

type Error = Error

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

fn try_from(der_bytes: &[u8]) -> Result<Self>

Performs the conversion.
source§

impl TryFrom<Vec<u8>> for Document

§

type Error = Error

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

fn try_from(der_bytes: Vec<u8>) -> Result<Self>

Performs the conversion.
source§

impl Eq for Document

source§

impl StructuralPartialEq for Document

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<'a, T> Choice<'a> for T
where T: Decode<'a> + FixedTag,

source§

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> Tagged for T
where T: FixedTag,

source§

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
source§

impl<T> DecodeOwned for T
where T: for<'a> Decode<'a>,