Struct CommitEnvelope 

pub struct CommitEnvelope { /* private fields */ }

An immutable signed commit blob.

Implementations

impl CommitEnvelope

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

Constructs a bounded commit envelope.

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

Returns the authenticated public header.

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

Returns the encrypted commit body and AEAD tag.

pub const fn signature(&self) -> CommitSignature

Returns the author signature.

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

Returns the exact canonical bytes covered by the signature.

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

Encodes a prospective header and ciphertext for signing.

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

Encodes the complete durable commit blob.

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

Strictly decodes the unique durable commit representation.

pub fn commit_id(&self) -> CommitId

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

Trait Implementations

impl Clone for CommitEnvelope

fn clone(&self) -> CommitEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitEnvelope

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

Formats the value using the given formatter.

impl PartialEq for CommitEnvelope

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

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

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 Eq for CommitEnvelope

impl StructuralPartialEq for CommitEnvelope