Struct Credentials 

pub struct Credentials { /* private fields */ }

API credentials for one account on one venue.

Construct with Credentials::new and, where the venue requires it, add a passphrase or private key. The secret fields are crate-private: exchange modules read them to sign requests, but they are never exposed to consumers.

Implementations

impl Credentials

pub fn new( api_key: impl Into<String>, api_secret: impl Into<String>, ) -> Credentials

Build credentials from an API key and secret.

pub fn with_passphrase(self, passphrase: impl Into<String>) -> Credentials

Attach the passphrase required by OKX, Bitget and KuCoin.

pub fn with_private_key(self, private_key: impl Into<String>) -> Credentials

Attach the private key used for Coinbase’s per-request JWT signing.

pub fn validate(&self) -> Result<(), Error>

Validate that the non-secret invariants hold: a non-empty key and secret.

Errors

Returns Error::InvalidCredentials if the key or secret is empty.

pub fn has_passphrase(&self) -> bool

Whether a passphrase is present (without revealing it).

pub fn has_private_key(&self) -> bool

Whether a private key is present (without revealing it).

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Redacts every field. Presence of the optional fields is shown, their contents never are.

impl Drop for Credentials

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.