Struct Envelope 

pub struct Envelope {
    pub d: String,
    pub f: String,
    pub m: EnvelopeMode,
    pub e: Option<u64>,
    pub v: u8,
}

A sealed envelope that carries data, its SHA-256 fingerprint, and an encoding mode.

Example

use entrouter_universal::Envelope;

let env = Envelope::wrap("secret payload");
assert_eq!(env.unwrap_verified().unwrap(), "secret payload");

Fields

d: String

Encoded data - opaque to every layer

f: String

SHA-256 fingerprint of the ORIGINAL raw input (before compression)

m: EnvelopeMode

Encoding mode

e: Option<u64>

Optional expiry as Unix timestamp (seconds)

v: u8

Version

Implementations

impl Envelope

pub fn wrap(input: &str) -> Self

Standard Base64 wrap.

pub fn wrap_url_safe(input: &str) -> Self

URL-safe Base64 wrap. Use when passing through URLs, query params, or HTTP headers. Uses - and _ instead of + and /. No padding.

pub fn wrap_compressed(input: &str) -> Result<Self, UniversalError>

Compressed wrap - gzip then Base64. Use for large payloads. Transparent to consumer - unwrap_verified() returns the original uncompressed string.

pub fn wrap_with_ttl(input: &str, ttl_secs: u64) -> Self

TTL wrap - standard Base64 with an expiry time. unwrap_verified() returns Err if the envelope has expired.

pub fn unwrap_verified(&self) -> Result<String, UniversalError>

Decode and verify integrity at the exit point. Works for all modes. Returns Err on:

• Integrity violation (data mutated in transit)
• Expired TTL
• Decode/decompress failure

pub fn unwrap_raw(&self) -> Result<String, UniversalError>

Decode without verification - use when you trust the source.

pub fn is_expired(&self) -> bool

Returns true if this envelope has expired (TTL mode only).

pub fn ttl_remaining(&self) -> Option<u64>

Seconds remaining until expiry. None if no TTL set.

pub fn is_intact(&self) -> bool

Returns true if the data passes integrity verification.

Convenience wrapper around Envelope::unwrap_verified.

pub fn fingerprint(&self) -> &str

Returns the SHA-256 fingerprint of the original data.

pub fn mode(&self) -> EnvelopeMode

Returns the EnvelopeMode used to create this envelope.

pub fn to_json(&self) -> Result<String, UniversalError>

Serialize this envelope to a JSON string.

pub fn from_json(s: &str) -> Result<Self, UniversalError>

Deserialize an envelope from a JSON string.

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Envelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Envelope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.