Struct digest_headers::Digest

pub struct Digest { /* fields omitted */ }

Defines the Digest type.

This type can be compared to another Digest, or turned into a String for use in request headers.

Methods

impl Digest

pub fn new(body: &[u8], size: ShaSize) -> Self

Creates a new Digest from a series of bytes representing a plaintext body and a ShaSize.

Example

let body = "Here's some text!";
let digest = Digest::new(body.as_bytes(), ShaSize::TwoFiftySix);

println!("Digest: {}", digest);

pub fn from_base64_and_size(digest: String, size: ShaSize) -> Self

Creates a new Digest from a base64-encoded digest String and a ShaSize.

Example

let sha_size = ShaSize::TwoFiftySix;
let digest_str = "bFp1K/TT36l9YQ8frlh/cVGuWuFEy1rCUNpGwQCSEow=";

let digest = Digest::from_base64_and_size(digest_str.to_owned(), sha_size);

println!("Digest: {}", digest);

pub fn sha_size(&self) -> ShaSize

Get the ShaSize of the current Digest

pub fn as_string(&self) -> String

Represents the Digest as a String.

This can be used to produce headers for HTTP Requests.

Example

let digest = Digest::new(b"Hello, world!", ShaSize::TwoFiftySix);

println!("Digest: {}", digest.as_string());

pub fn verify(&self, body: &[u8]) -> Result<(), Error>

Verify a given message body with the digest.

Example

let body = b"Some message body";
let digest = Digest::new(body, ShaSize::TwoFiftySix);

assert!(digest.verify(body).is_ok());

Trait Implementations

impl Eq for Digest

impl PartialEq<Digest> 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: &Digest) -> bool

This method tests for !=.

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

Formats the value using the given formatter.

impl Display for Digest

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

Formats the value using the given formatter.

impl FromStr for Digest

type Err = Error

The associated error which can be returned from parsing.

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

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