Struct CredentialMetadata 

pub struct CredentialMetadata {
    pub client_id: Option<String>,
    pub scopes: Vec<String>,
    pub user_agent: Option<String>,
    pub client_ip: Option<String>,
    pub custom: HashMap<String, String>,
}

Additional credential metadata that can be attached to any credential type.

Use the builder methods to construct metadata fluently:

let meta = CredentialMetadata::new()
    .client_id("my-app")
    .client_ip("10.0.0.1")
    .scope("read")
    .scope("write");

Fields

client_id: Option<String>

Client identifier (for OAuth flows).

scopes: Vec<String>

Requested scopes (e.g. ["read", "write"]).

user_agent: Option<String>

User-Agent string from the HTTP request, if available.

client_ip: Option<String>

IP address of the authenticating client, if available.

custom: HashMap<String, String>

Additional custom metadata key-value pairs.

Implementations

impl CredentialMetadata

pub fn new() -> Self

Create empty credential metadata.

pub fn client_id(self, client_id: impl Into<String>) -> Self

Set the OAuth client identifier.

pub fn scope(self, scope: impl Into<String>) -> Self

Append a single scope to the requested scopes.

pub fn scopes(self, scopes: Vec<String>) -> Self

Replace the requested scopes with the given list.

pub fn user_agent(self, user_agent: impl Into<String>) -> Self

Set the User-Agent header value from the HTTP request.

pub fn client_ip(self, client_ip: impl Into<String>) -> Self

Set the IP address of the authenticating client.

pub fn custom(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a custom metadata key-value pair.

Trait Implementations

impl Clone for CredentialMetadata

fn clone(&self) -> CredentialMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CredentialMetadata

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

Formats the value using the given formatter.

impl Default for CredentialMetadata

fn default() -> CredentialMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CredentialMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CredentialMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.