pub struct AccessController { /* private fields */ }Expand description
Access controller for managing API keys and enforcing limits
Implementations§
Source§impl AccessController
impl AccessController
Sourcepub fn create_key(&self, name: impl Into<String>) -> ApiKey
pub fn create_key(&self, name: impl Into<String>) -> ApiKey
Create a new API key
Sourcepub fn create_custom_key(&self, key: ApiKey) -> String
pub fn create_custom_key(&self, key: ApiKey) -> String
Create a custom API key
Sourcepub fn revoke_key(&self, key: &str) -> bool
pub fn revoke_key(&self, key: &str) -> bool
Revoke an API key
Sourcepub fn delete_key(&self, key: &str) -> bool
pub fn delete_key(&self, key: &str) -> bool
Delete an API key
Sourcepub fn validate(
&self,
key: &str,
permission: Permission,
bytes: u64,
) -> Result<(), AccessError>
pub fn validate( &self, key: &str, permission: Permission, bytes: u64, ) -> Result<(), AccessError>
Validate an API key and check permissions
Sourcepub fn get_usage(&self, key: &str) -> Option<UsageSnapshot>
pub fn get_usage(&self, key: &str) -> Option<UsageSnapshot>
Get usage statistics for a key
Sourcepub fn get_all_usage(&self) -> HashMap<String, UsageSnapshot>
pub fn get_all_usage(&self) -> HashMap<String, UsageSnapshot>
Get statistics for all keys
Trait Implementations§
Auto Trait Implementations§
impl Freeze for AccessController
impl RefUnwindSafe for AccessController
impl Send for AccessController
impl Sync for AccessController
impl Unpin for AccessController
impl UnwindSafe for AccessController
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian().Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.