pub struct Document { /* private fields */ }
Available on crate feature pkcs8 only.
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§

§

impl Document

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

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

pub fn into_secret(self) -> SecretDocument

Available on crate feature zeroize only.

Convert to a SecretDocument.

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

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

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

Return an ASN.1 DER-encoded byte vector.

pub fn len(&self) -> Length

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

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

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

pub fn encode_msg<T>(msg: &T) -> Result<Document, Error>where
    T: Encode,

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

Trait Implementations§

§

impl AsRef<[u8]> for Document

§

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

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

impl Clone for Document

§

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
§

impl Debug for Document

§

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

Formats the value using the given formatter. Read more
§

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

§

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

Attempt to decode this message using the provided decoder.
§

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

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

impl Encode for Document

§

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

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

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

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

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

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

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

Available on crate feature alloc only.
Encode this message as ASN.1 DER, appending it to the provided byte vector.
§

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

Available on crate feature alloc only.
Serialize this message as a byte vector.
§

impl FixedTag for Document

§

const TAG: Tag = Tag::Sequence

ASN.1 tag
§

impl From<Document> for SecretDocument

Available on crate feature zeroize only.
§

fn from(doc: Document) -> SecretDocument

Converts to this type from the input type.
§

impl PartialEq<Document> for Document

§

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

impl TryFrom<&[u8]> for Document

§

type Error = Error

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

fn try_from(der_bytes: &[u8]) -> Result<Document, Error>

Performs the conversion.
§

impl TryFrom<&SubjectPublicKeyInfo<'_>> for Document

Available on crate feature alloc only.
§

type Error = Error

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

fn try_from(spki: &SubjectPublicKeyInfo<'_>) -> Result<Document, Error>

Performs the conversion.
§

impl TryFrom<SubjectPublicKeyInfo<'_>> for Document

Available on crate feature alloc only.
§

type Error = Error

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

fn try_from(spki: SubjectPublicKeyInfo<'_>) -> Result<Document, Error>

Performs the conversion.
§

impl TryFrom<Vec<u8, Global>> for Document

§

type Error = Error

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

fn try_from(der_bytes: Vec<u8, Global>) -> Result<Document, Error>

Performs the conversion.
§

impl Eq for Document

§

impl StructuralEq for Document

§

impl StructuralPartialEq for Document

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
§

impl<'a, T> Choice<'a> for Twhere
    T: Decode<'a> + FixedTag,

§

fn can_decode(tag: Tag) -> bool

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

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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<T> for T

§

type Output = T

Should always be Self
§

impl<T> Tagged for Twhere
    T: FixedTag,

§

fn tag(&self) -> Tag

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

impl<T> ToOwned for Twhere
    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 Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

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