Skip to main content

CanonicalEncoder

Struct CanonicalEncoder 

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

An in-progress canonical encoding, opened under one domain tag.

Every value is length-prefixed (u64 big-endian) so no concatenation can alias two encodings; lists are additionally count-prefixed.

Implementations§

Source§

impl CanonicalEncoder

Source

pub fn new(domain_tag: &[u8]) -> Self

Open an encoding under a domain tag such as b"perspt-prompt-v1". The tag itself is the first length-prefixed field.

Source

pub fn field(&mut self, bytes: &[u8]) -> &mut Self

Append one length-prefixed byte field.

Source

pub fn text(&mut self, value: &str) -> &mut Self

Append one length-prefixed UTF-8 field.

Source

pub fn u64(&mut self, value: u64) -> &mut Self

Append a fixed-width unsigned integer (no length prefix needed).

Source

pub fn bool(&mut self, value: bool) -> &mut Self

Append one boolean byte.

Source

pub fn list<I>(&mut self, entries: I) -> &mut Self

Append a count-prefixed list of text entries.

Source

pub fn finish(self) -> Vec<u8> ⓘ

The finished canonical bytes.

Source

pub fn digest(self) -> String

SHA-256 over the finished canonical bytes, hex encoded with a sha256: prefix so a digest names its own algorithm.

Trait Implementations§

Source§

impl Debug for CanonicalEncoder

Source§

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

Formats the value using the given formatter. Read more

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> 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> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.