Struct bc_envelope::prelude::Digest

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

A cryptographically secure digest, implemented with SHA-256.

Implementations

impl Digest

pub const DIGEST_SIZE: usize = 32usize

pub fn from_data(data: [u8; 32]) -> Digest

Create a new digest from data.

pub fn from_data_ref(data: impl AsRef<[u8]>) -> Result<Digest, Error>

Create a new digest from data.

Returns None if the data is not the correct length.

pub fn from_image(image: impl AsRef<[u8]>) -> Digest

Create a new digest from the given image.

The image is hashed with SHA-256.

pub fn from_image_parts(image_parts: &[&[u8]]) -> Digest

Create a new digest from an array of data items.

The image parts are concatenated and hashed with SHA-256.

pub fn from_digests(digests: &[Digest]) -> Digest

Create a new digest from an array of Digests.

The image parts are concatenated and hashed with SHA-256.

pub fn data(&self) -> &[u8; 32]

Get the data of the digest.

pub fn validate(&self, image: impl AsRef<[u8]>) -> bool

Validate the digest against the given image.

The image is hashed with SHA-256 and compared to the digest. Returns true if the digest matches the image.

pub fn from_hex(hex: impl AsRef<str>) -> Digest

Create a new digest from the given hexadecimal string.

Panics

Panics if the string is not exactly 64 hexadecimal digits.

pub fn hex(&self) -> String

The data as a hexadecimal string.

pub fn short_description(&self) -> String

The first four bytes of the digest as a hexadecimal string.

pub fn validate_opt(image: impl AsRef<[u8]>, digest: Option<&Digest>) -> bool

Validate the given data against the digest, if any.

Returns true if the digest is None or if the digest matches the image’s digest. Returns false if the digest does not match the image’s digest.

Trait Implementations

impl AsRef<[u8]> for Digest

fn as_ref(&self) -> &[u8]

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

impl AsRef<Digest> for Digest

fn as_ref(&self) -> &Digest

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

impl CBORTagged for Digest

fn cbor_tags() -> Vec<Tag>

The CBOR tags assocated with this type. If more than one tag is present, they are considered equivalent for reading, but only the first one is used for writing.

impl CBORTaggedDecodable for Digest

fn from_untagged_cbor(cbor: CBOR) -> Result<Digest, Error>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for Digest

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for Digest

fn clone(&self) -> Digest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Digest

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

Formats the value using the given formatter.

impl DigestProvider for Digest

fn digest(&self) -> Cow<'_, Digest>

impl Display for Digest

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

Formats the value using the given formatter.

impl EnvelopeEncodable for Digest

fn into_envelope(self) -> Envelope

fn to_envelope(&self) -> Envelope

where Self: Clone,

impl EnvelopeFormat for Digest

fn format_item(&self, _context: &FormatContext) -> EnvelopeFormatItem

impl<'a> From<&'a Digest> for &'a [u8]

fn from(value: &'a Digest) -> &'a [u8]

Converts to this type from the input type.

impl<'a> From<&'a Digest> for &'a [u8; 32]

fn from(value: &'a Digest) -> &'a [u8; 32]

Converts to this type from the input type.

impl From<&Digest> for Digest

fn from(digest: &Digest) -> Digest

Converts to this type from the input type.

impl From<&Digest> for Vec<u8>

fn from(digest: &Digest) -> Vec<u8>

Converts to this type from the input type.

impl From<Digest> for CBOR

fn from(value: Digest) -> CBOR

Converts to this type from the input type.

impl From<Digest> for Vec<u8>

fn from(digest: Digest) -> Vec<u8>

Converts to this type from the input type.

impl Hash for Digest

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Digest

fn cmp(&self, other: &Digest) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Digest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Digest

fn partial_cmp(&self, other: &Digest) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<CBOR> for Digest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Digest, <Digest as TryFrom<CBOR>>::Error>

Performs the conversion.

impl Eq for Digest

impl StructuralPartialEq for Digest