Struct CanonicalBytes 

pub struct CanonicalBytes(/* private fields */);

Newtype wrapper over canonical JCS output bytes.

Construction is restricted to this crate — callers obtain a CanonicalBytes only by routing through canonical_bytes_from_slice (or the wrappers in vertrule-core::determinism). The type exists so digest, signature, and receipt APIs can statically require “bytes that came out of JCS” rather than accepting any &[u8]. Every coercion back to &[u8] goes through the explicit Self::as_slice method — there is no AsRef<[u8]> or Deref impl, so escapes are greppable.

The Debug impl deliberately shows the byte length and not the bytes. Dumping raw canonical JSON into a log is a common way to accidentally leak receipt contents; callers that want the bytes must ask for them.

Implementations

impl CanonicalBytes

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

Explicit escape hatch to a byte slice. Named so reviewers can grep for the boundary where canonical-bytes discipline is dropped (e.g., feeding wire bytes to blake3::hash).

pub fn len(&self) -> usize

Length in bytes.

pub fn is_empty(&self) -> bool

True when the canonical output is empty (only possible for an empty input in degenerate paths; not reachable from the primary API).

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

Consume the wrapper and return the underlying byte buffer. Use at wire boundaries where ownership is transferred (file write, network send). Not an implicit coercion.

Trait Implementations

impl Clone for CanonicalBytes

fn clone(&self) -> CanonicalBytes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalBytes

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

Formats the value using the given formatter.

impl PartialEq for CanonicalBytes

fn eq(&self, other: &CanonicalBytes) -> 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 CanonicalBytes

impl StructuralPartialEq for CanonicalBytes