Struct bandsocks::ContentDigest

pub struct ContentDigest { /* fields omitted */ }

A digest securely identifies the specific contents of a binary object

Digests include the hash format, which is currently always sha256

Implementations

impl ContentDigest

pub fn as_str(&self) -> &str

Returns a reference to the existing string representation of a ContentDigest

This string always has a single colon. After the colon is 32 or more characters which will always be lowercase hexadecimal digits. The format specifier before this colon is alphanumeric, with plus, dash, underscore, or dot characters allowed as separators between valid groups of alphanumeric characters.

pub fn from_parts<T: LowerHex>(
    format_part: &str,
    hex_part: &T
) -> Result<Self, ImageError>

Create a new ContentDigest from parts

The format string and hex string are assembled and parsed.

pub fn from_content(content_bytes: &[u8]) -> Self

Create a new ContentDigest from content data

This hashes the content using the the sha256 algorithm.

let digest = ContentDigest::from_content(b"cat");
assert_eq!(digest.as_str(), "sha256:77af778b51abd4a3c51c5ddd97204a9c3ae614ebccb75a606c3b6865aed6744e");

pub fn parse(s: &str) -> Result<Self, ImageError>

Parse a str as a ContentDigest

let digest = ContentDigest::parse("format:00112233445566778899aabbccddeeff").unwrap();
assert_eq!(digest.format_str(), "format");
assert_eq!(digest.hex_str(), "00112233445566778899aabbccddeeff")

pub fn format_str(&self) -> &str

Return a reference to the format string portion of this digest.

Currently this is sha256 for all digests we create or recognize.

pub fn hex_str(&self) -> &str

Return a reference to the hexadecimal string portion of this digest.

This is guaranteed to be a string of at least 32 hex digits.

Trait Implementations

impl Clone for ContentDigest

pub fn clone(&self) -> ContentDigest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentDigest

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

Formats the value using the given formatter.

impl Display for ContentDigest

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

Formats the value using the given formatter.

impl Eq for ContentDigest

impl FromStr for ContentDigest

type Err = ImageError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ContentDigest

pub fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ContentDigest

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ContentDigest> for ContentDigest

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ContentDigest> for ContentDigest

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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