Struct Credentials 

pub struct Credentials {
    pub instance: String,
    pub jwt_token: String,
    pub user: Option<UserId>,
    pub name: Option<String>,
    pub email: Option<String>,
    pub expires_at: Option<String>,
    pub server_url: Option<String>,
    pub refresh_token: Option<String>,
    pub refresh_expires_at: Option<String>,
}

Stored credentials for a KalamDB instance.

Contains a JWT token that can be persisted and reused across sessions. The token is obtained by authenticating with user/password via the /v1/api/auth/login endpoint.

Fields

instance: String

Database instance identifier (e.g., “local”, “production”, URL)

jwt_token: String

JWT access token for authentication Obtained from the login endpoint, expires after a configured period

user: Option<UserId>

User associated with this token (for display purposes)

name: Option<String>

Preferred human-friendly name for this account, if available.

email: Option<String>

Email associated with this token (for display purposes)

expires_at: Option<String>

Token expiration time in RFC3339 format (optional, for cache invalidation)

server_url: Option<String>

Optional: Server URL if different from instance name

refresh_token: Option<String>

Refresh token for obtaining new access tokens (longer-lived)

refresh_expires_at: Option<String>

Refresh token expiration time in RFC3339 format

Implementations

impl Credentials

pub fn new(instance: String, jwt_token: String) -> Credentials

Create new credentials with a JWT token

pub fn with_details( instance: String, jwt_token: String, user: impl Into<UserId>, expires_at: String, server_url: Option<String>, ) -> Credentials

Create new credentials with full details

pub fn with_refresh_token( instance: String, jwt_token: String, user: impl Into<UserId>, expires_at: String, server_url: Option<String>, refresh_token: Option<String>, refresh_expires_at: Option<String>, ) -> Credentials

Create new credentials with full details including refresh token

pub fn with_identity_metadata( self, name: Option<String>, email: Option<String>, ) -> Credentials

Attach human-friendly identity metadata.

pub fn display_label(&self) -> Option<&str>

Preferred display label for this identity.

pub fn get_server_url(&self) -> &str

Get the server URL, defaulting to instance name if not set

pub fn is_expired(&self) -> bool

Check if the access token has expired (if expiration is known) Returns false if expiration is unknown (assume valid)

pub fn is_refresh_expired(&self) -> bool

Check if the refresh token has expired (if expiration is known) Returns true if no refresh token is available or if it has expired

pub fn can_refresh(&self) -> bool

Check if we can refresh the access token

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>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credentials

fn deserialize<__D>( __deserializer: __D, ) -> Result<Credentials, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Credentials

fn eq(&self, other: &Credentials) -> 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 Serialize for Credentials

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Credentials