Struct Credential 

pub struct Credential { /* private fields */ }

L2 API credential with HMAC-SHA256 signing for authenticated requests.

Stores the API key as Ustr (interned, used for lookups) and the decoded secret as Box<[u8]> (zeroized on drop). The base64 secret and HMAC key are initialized once to avoid repeated setup per request. aws-lc-rs cleanses the native HMAC context when the key is dropped.

Implementations

impl Credential

pub fn new(api_key: &str, api_secret: &str, passphrase: String) -> Result<Self>

Creates a new credential. The api_secret must be base64-encoded.

pub fn api_key(&self) -> Ustr

pub fn passphrase(&self) -> &str

pub fn api_secret(&self) -> String

Returns the raw API secret as a base64-encoded string.

Used for WebSocket user channel authentication which expects the raw secret (not an HMAC signature).

pub fn sign( &self, timestamp: &str, method: &str, request_path: &str, body: &str, ) -> String

Signs a request with HMAC-SHA256 and returns the base64-encoded signature.

Message format: {timestamp}{method}{request_path}{body}

pub fn resolve( api_key: Option<String>, api_secret: Option<String>, passphrase: Option<String>, ) -> Result<Self>

Resolves from provided values, falling back to environment variables.

pub fn from_env() -> Result<Self>

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl Drop for Credential

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.