Struct Key 

pub struct Key(/* private fields */);

An opaque identity a rate limit is tracked against.

A Key is whatever distinguishes one caller (or tenant, route, or resource) from another: an IP address, a user id, an API token, an endpoint name. It is stored as an owned byte string — inline for keys up to a couple dozen bytes, on the heap beyond that — and two keys are equal exactly when their bytes are equal, so the identity is the byte content, not the source type.

You rarely name Key directly. The check methods accept impl Into<Key>, and this module provides From conversions for the common identity types, so limiter.check("user:42") and limiter.check(ip) both work. Small keys are stored inline, which is what keeps an existing-key check allocation-free.

Examples

use rate_net::Key;

let a: Key = "tenant:acme".into();
let b: Key = String::from("tenant:acme").into();
assert_eq!(a, b);
assert_eq!(a.as_bytes(), b"tenant:acme");

Implementations

impl Key

pub fn as_bytes(&self) -> &[u8]

Borrows the raw bytes that make up the key.

Examples

use rate_net::Key;

let key: Key = "abc".into();
assert_eq!(key.as_bytes(), b"abc");

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl From<&[u8]> for Key

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Key

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<IpAddr> for Key

fn from(value: IpAddr) -> Self

Converts to this type from the input type.

impl From<String> for Key

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Key

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<u64> for Key

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for Key

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Key

fn eq(&self, other: &Self) -> 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 Eq for Key