Enum SignableBody

#[non_exhaustive]
pub enum SignableBody<'a> {
    Bytes(&'a [u8]),
    UnsignedPayload,
    Precomputed(String),
    StreamingUnsignedPayloadTrailer,
}

Available on crate feature sign-http only.

A signable HTTP request body

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bytes(&'a [u8])

A body composed of a slice of bytes

UnsignedPayload

An unsigned payload

UnsignedPayload is used for streaming requests where the contents of the body cannot be known prior to signing

Precomputed(String)

A precomputed body checksum. The checksum should be a SHA256 checksum of the body, lowercase hex encoded. Eg: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

StreamingUnsignedPayloadTrailer

Set when a streaming body has checksum trailers.

Implementations

impl SignableBody<'_>

pub fn empty() -> SignableBody<'static>

Create a new empty signable body

Trait Implementations

impl<'a> Clone for SignableBody<'a>

fn clone(&self) -> SignableBody<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SignableBody<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for SignableBody<'a>

fn eq(&self, other: &SignableBody<'a>) -> 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<'a> Eq for SignableBody<'a>

impl<'a> StructuralPartialEq for SignableBody<'a>