Struct spki::PublicKeyDocument

source · [−]

pub struct PublicKeyDocument(_);

This is supported on crate feature alloc only.

Expand description

SPKI public key document.

This type provides storage for SubjectPublicKeyInfo encoded as ASN.1 DER with the invariant that the contained-document is “well-formed”, i.e. it will parse successfully according to this crate’s parsing rules.

Trait Implementations

source

impl AsRef<[u8 ]> for PublicKeyDocument

source

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Performs the conversion.

source

impl Clone for PublicKeyDocument

source

fn clone(&self) -> PublicKeyDocument

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 PublicKeyDocument

source

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

Formats the value using the given formatter. Read more

source

impl DecodePublicKey for PublicKeyDocument

source

fn from_public_key_der(bytes: &[u8 ]) -> Result<Self>

Deserialize object from ASN.1 DER-encoded SubjectPublicKeyInfo (binary format). Read more

source

fn from_public_key_pem(s: &str) -> Result<Self>

This is supported on crate feature pem only.

Deserialize PEM-encoded SubjectPublicKeyInfo. Read more

source

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

This is supported on crate feature std only.

Load public key object from an ASN.1 DER-encoded file on the local filesystem (binary format). Read more

source

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

This is supported on crate features pem and std only.

Load public key object from a PEM-encoded file on the local filesystem.

source

fn from_public_key_doc(doc: &PublicKeyDocument) -> Result<Self>

This is supported on crate feature alloc only.

Deserialize SPKI public key from a PublicKeyDocument.

source

impl<'a> Document<'a> for PublicKeyDocument

type Message = SubjectPublicKeyInfo<'a>

ASN.1 message type this document decodes to.

source

const SENSITIVE: bool

Does this type contain potentially sensitive data? Read more

source

fn as_der(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Borrow the inner serialized bytes of this document.

source

fn to_der(&self) -> Box<[u8 ], Global>

Return an allocated ASN.1 DER serialization as a boxed slice.

source

fn decode(&'a self) -> Self::Message

Decode this document as ASN.1 DER.

source

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

Create a new document from the provided ASN.1 DER bytes.

source

fn from_msg(msg: &Self::Message) -> Result<Self, Error>

Encode the provided type as ASN.1 DER.

source

fn from_pem(s: &str) -> Result<Self, Error> where
Self: PemLabel,

Decode ASN.1 DER document from PEM.

source

fn to_pem(&self, line_ending: LineEnding) -> Result<String, Error> where
Self: PemLabel,

Encode ASN.1 DER document as a PEM string.

source

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

Read ASN.1 DER document from a file.

source

fn read_pem_file(path: impl AsRef<Path>) -> Result<Self, Error> where
Self: PemLabel,

Read PEM-encoded ASN.1 DER document from a file.

source

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

Write ASN.1 DER document to a file.

source

fn write_pem_file(
 &self,
 path: impl AsRef<Path>,
 line_ending: LineEnding
) -> Result<(), Error> where
 Self: PemLabel,

Write PEM-encoded ASN.1 DER document to a file.

source

impl EncodePublicKey for PublicKeyDocument

source

fn to_public_key_der(&self) -> Result<PublicKeyDocument>

This is supported on crate feature alloc only.

Serialize a PublicKeyDocument containing a SPKI-encoded public key.

source

fn to_public_key_pem(&self, line_ending: LineEnding) -> Result<String>

This is supported on crate features alloc and pem only.

Serialize this public key as PEM-encoded SPKI with the given LineEnding.

source

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

This is supported on crate features alloc and std only.

Write ASN.1 DER-encoded public key to the given path

source

fn write_public_key_pem_file(
 &self,
 path: impl AsRef<Path>,
 line_ending: LineEnding
) -> Result<()>

This is supported on crate features pem and std and alloc only.

Write ASN.1 DER-encoded public key to the given path

source

impl FromStr for PublicKeyDocument

This is supported on crate feature pem only.

type Err = Error

The associated error which can be returned from parsing.

source

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type. Read more

source

impl PemLabel for PublicKeyDocument

This is supported on crate feature pem only.

source

const TYPE_LABEL: &'static str

Expected PEM type label for a given document, e.g. "PRIVATE KEY"

source

fn validate_pem_label(actual: &str) -> Result<(), Error>

Validate that a given label matches the expected label.

source

impl TryFrom<&'_ [u8 ]> for PublicKeyDocument

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(spki: &SubjectPublicKeyInfo<'_>) -> Result<PublicKeyDocument>

Performs the conversion.

source

impl TryFrom<SubjectPublicKeyInfo<'_>> for PublicKeyDocument

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(spki: SubjectPublicKeyInfo<'_>) -> Result<PublicKeyDocument>

Performs the conversion.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for PublicKeyDocument

impl Send for PublicKeyDocument

impl Sync for PublicKeyDocument

impl Unpin for PublicKeyDocument

impl UnwindSafe for PublicKeyDocument

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
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

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)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct spki::PublicKeyDocument

Trait Implementations

impl AsRef<[u8]> for PublicKeyDocument

fn as_ref(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

impl Clone for PublicKeyDocument

fn clone(&self) -> PublicKeyDocument

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

impl Debug for PublicKeyDocument

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

impl DecodePublicKey for PublicKeyDocument

fn from_public_key_der(bytes: &[u8]) -> Result<Self>

fn from_public_key_pem(s: &str) -> Result<Self>

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

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

fn from_public_key_doc(doc: &PublicKeyDocument) -> Result<Self>

impl<'a> Document<'a> for PublicKeyDocument

type Message = SubjectPublicKeyInfo<'a>

const SENSITIVE: bool

fn as_der(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

fn to_der(&self) -> Box<[u8], Global>

fn decode(&'a self) -> Self::Message

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

fn from_msg(msg: &Self::Message) -> Result<Self, Error>

fn from_pem(s: &str) -> Result<Self, Error> where Self: PemLabel,

fn to_pem(&self, line_ending: LineEnding) -> Result<String, Error> where Self: PemLabel,

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

fn read_pem_file(path: impl AsRef<Path>) -> Result<Self, Error> where Self: PemLabel,

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

fn write_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding) -> Result<(), Error> where Self: PemLabel,

impl EncodePublicKey for PublicKeyDocument

fn to_public_key_der(&self) -> Result<PublicKeyDocument>

fn to_public_key_pem(&self, line_ending: LineEnding) -> Result<String>

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

fn write_public_key_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding) -> Result<()>

impl FromStr for PublicKeyDocument

type Err = Error

fn from_str(s: &str) -> Result<Self>

impl PemLabel for PublicKeyDocument

const TYPE_LABEL: &'static str

fn validate_pem_label(actual: &str) -> Result<(), Error>

impl TryFrom<&'_ [u8]> for PublicKeyDocument

type Error = Error

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

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

type Error = Error

fn try_from(spki: &SubjectPublicKeyInfo<'_>) -> Result<PublicKeyDocument>

impl TryFrom<SubjectPublicKeyInfo<'_>> for PublicKeyDocument

type Error = Error

fn try_from(spki: SubjectPublicKeyInfo<'_>) -> Result<PublicKeyDocument>

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

type Error = Error

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

Auto Trait Implementations

impl RefUnwindSafe for PublicKeyDocument

impl Send for PublicKeyDocument

impl Sync for PublicKeyDocument

impl Unpin for PublicKeyDocument

impl UnwindSafe for PublicKeyDocument

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

impl AsRef<[u8 ]> for PublicKeyDocument

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn from_public_key_der(bytes: &[u8 ]) -> Result<Self>

fn as_der(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn to_der(&self) -> Box<[u8 ], Global>

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

fn from_pem(s: &str) -> Result<Self, Error> where
Self: PemLabel,

fn to_pem(&self, line_ending: LineEnding) -> Result<String, Error> where
Self: PemLabel,

fn read_pem_file(path: impl AsRef<Path>) -> Result<Self, Error> where
Self: PemLabel,

fn write_pem_file(
&self,
path: impl AsRef<Path>,
line_ending: LineEnding
) -> Result<(), Error> where
Self: PemLabel,

fn write_public_key_pem_file(
&self,
path: impl AsRef<Path>,
line_ending: LineEnding
) -> Result<()>

impl TryFrom<&'_ [u8 ]> for PublicKeyDocument

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

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

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

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

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

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

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

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