CommitEnvelope

Struct CommitEnvelope 

Source
pub struct CommitEnvelope { /* private fields */ }
Expand description

An immutable signed commit blob.

Implementations§

Source§

impl CommitEnvelope

Source

pub fn new( header: CommitHeader, ciphertext: Vec<u8>, signature: CommitSignature, ) -> Result<Self, CommitCodecError>

Constructs a bounded commit envelope.

Source

pub const fn header(&self) -> &CommitHeader

Returns the authenticated public header.

Source

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

Returns the encrypted commit body and AEAD tag.

Source

pub const fn signature(&self) -> CommitSignature

Returns the author signature.

Source

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

Returns the exact canonical bytes covered by the signature.

Source

pub fn signing_bytes_for( header: &CommitHeader, ciphertext: &[u8], ) -> Result<Vec<u8>, CommitCodecError>

Encodes a prospective header and ciphertext for signing.

Source

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

Encodes the complete durable commit blob.

Source

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

Strictly decodes the unique durable commit representation.

Source

pub fn commit_id(&self) -> CommitId

Returns the iroh-blobs-compatible BLAKE3 hash of the exact blob bytes.

Trait Implementations§

Source§

impl Clone for CommitEnvelope

Source§

fn clone(&self) -> CommitEnvelope

Returns a duplicate 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 CommitEnvelope

Source§

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

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

impl PartialEq for CommitEnvelope

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for CommitEnvelope

Source§

impl StructuralPartialEq for CommitEnvelope

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Source§

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>,

Source§

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>,

Source§

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.