Struct ProtoEnvelope

pub struct ProtoEnvelope<Contents> { /* private fields */ }

The envelope struct is used to keep around the original bytes that the content was serialized into in case the serialization is not canonical.

Implementations

impl<Contents> ProtoEnvelope<Contents>

pub fn signed_contents( private_key: &PrivateKey, contents: Contents, ) -> Result<Self, SignatureError>

where Contents: Signable,

Create an envelope for some contents using a signature.

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

Get the byte representation of the envelope contents.

pub fn key_id(&self) -> &KeyID

pub fn signature(&self) -> &Signature

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

Get the representation of the entire envelope as a byte vector. This is the logical inverse of Envelope::from_bytes.

pub fn from_protobuf(bytes: &[u8]) -> Result<Self, ParseEnvelopeError>

where Contents: Decode,

Create an entire envelope from a byte vector. This is the logical inverse of Envelope::as_bytes.

Trait Implementations

impl<Content> AsRef<Content> for ProtoEnvelope<Content>

fn as_ref(&self) -> &Content

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

impl<Contents: Clone> Clone for ProtoEnvelope<Contents>

fn clone(&self) -> ProtoEnvelope<Contents>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Contents: Debug> Debug for ProtoEnvelope<Contents>

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

Formats the value using the given formatter.

impl<Content> From<ProtoEnvelope<Content>> for ProtoEnvelopeBody

fn from(value: ProtoEnvelope<Content>) -> Self

Converts to this type from the input type.

impl<Contents: PartialEq> PartialEq for ProtoEnvelope<Contents>

fn eq(&self, other: &ProtoEnvelope<Contents>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Content> TryFrom<ProtoEnvelopeBody> for ProtoEnvelope<Content>

where Content: Decode,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: ProtoEnvelopeBody) -> Result<Self, Self::Error>

Performs the conversion.

impl<Contents: Eq> Eq for ProtoEnvelope<Contents>

impl<Contents> StructuralPartialEq for ProtoEnvelope<Contents>