Struct AuthRateLimitKey 

pub struct AuthRateLimitKey {
    pub kind: AuthRateLimitKind,
    pub subject: Option<String>,
    pub realm: Option<String>,
    pub peer: Option<String>,
}

Rate-limit key. Fields are optional so applications can key by peer, realm, subject, or any combination their deployment supports.

Fields

kind: AuthRateLimitKind

Operation category.

subject: Option<String>

Subject or username when known.

realm: Option<String>

Realm, issuer, tenant, or provider name when known.

peer: Option<String>

Source peer, IP, connection id, or SIP source when known.

Implementations

impl AuthRateLimitKey

pub fn new(kind: AuthRateLimitKind) -> AuthRateLimitKey

Create a key for an auth operation.

pub fn with_subject(self, subject: impl Into<String>) -> AuthRateLimitKey

Attach a subject or username.

pub fn with_realm(self, realm: impl Into<String>) -> AuthRateLimitKey

Attach a realm, issuer, tenant, or provider name.

pub fn with_peer(self, peer: impl Into<String>) -> AuthRateLimitKey

Attach a peer identifier.

Trait Implementations

impl Clone for AuthRateLimitKey

fn clone(&self) -> AuthRateLimitKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthRateLimitKey

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

Formats the value using the given formatter.

impl Eq for AuthRateLimitKey

impl PartialEq for AuthRateLimitKey

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