Skip to main content

Ratelimit

kernel::ratelimit

Struct Ratelimit 

Source 
pub struct Ratelimit { /* private fields */ }
Expand description

Rate limiter state.

§Invariants

The inner field contains an initialized struct ratelimit_state.

Implementations§

Source§

impl Ratelimit

Source

pub fn project<'__this>(self: Pin<&'__this mut Self>) -> __Projection<'__this>

Pin-projects all fields of Self.

These fields are structurally pinned:

  • inner

These fields are not structurally pinned:

Source

pub fn with_project<'__this, R>( self: Pin<&'__this mut Self>, f: impl FnOnce(__ProjectionLt<'__this>) -> R, ) -> R

Pin-projects all fields of Self with proper lifetime.

These fields are structurally pinned:

  • inner

These fields are not structurally pinned:

Source

pub fn with_project_ref<'__this, R>( self: Pin<&'__this Self>, f: impl FnOnce(__ProjectionRef<'__this>) -> R, ) -> R

Pin-projects all fields of Self from a shared reference with proper lifetime.

These fields are structurally pinned:

  • inner

These fields are not structurally pinned:

Source§

impl Ratelimit

Source

pub const DEFAULT_INTERVAL: i32

The default interval used for rate limiting.

Source

pub const DEFAULT_BURST: i32

The default burst size.

Source

pub fn new(interval: i32, burst: i32) -> impl PinInit<Self>

Constructs a Ratelimit with the specified configuration.

If interval is zero, then no rate limit is applied.

Source

pub fn new_default() -> impl PinInit<Self>

Constructs a Ratelimit with the default configuration.

Source

pub const unsafe fn new_static( name: &'static CStr, interval: i32, burst: i32, ) -> Self

Constructs a Ratelimit with the specified configuration.

The name will be used for the lockdep name of the internal spinlock. See Self::new for the meaning of interval and burst.

§Safety

The resulting value must be stored in static memory.

Source

pub fn ratelimit(&self, func: &CStr) -> bool

Check if an action should be rate-limited.

Returns true if the action is allowed, and false if it should be suppressed.

Trait Implementations§

Source§

impl Drop for Ratelimit

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl HasPinData for Ratelimit

Source§

type PinData = __ThePinData

Source§

fn __pin_data(_: InitData<Self>) -> Self::PinData

Source§

impl PinnedDrop for Ratelimit

Source§

fn drop(self: Pin<&mut Self>, _: OnlyCallFromDrop)

Executes the pinned destructor of this type. Read more
Source§

impl Send for Ratelimit

Source§

impl Sync for Ratelimit

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Init<T> for T

Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<S, T> IntoSafeCast<T> for S
where T: FromSafeCast<S>,

Source§

fn into_safe_cast(self) -> T

Convert self into a T. This operation is guaranteed to be lossless.
Source§

impl<S, T> IntoSafeCastArch<T> for S
where T: FromSafeCastArch<S>,

Source§

fn into_safe_cast_arch(self) -> T

Convert self into a T. This operation is guaranteed to be lossless.
Source§

impl<T> KnownSize for T

Source§

const MIN_SIZE: usize = const MIN_SIZE: usize = size_of::<T>();

Minimum size of this type known at compile-time.
Source§

const MIN_ALIGN: Alignment = const MIN_ALIGN: Alignment = Alignment::of::<T>();

Minimum alignment of this type known at compile-time.
Source§

fn size(_: *const T) -> usize

Get the size of an object of this type in bytes, with the metadata of the given pointer.
Source§

impl<T> PinInit<T> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), !>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U, const N: u32> TryIntoBounded<T, N> for U
where T: Integer, U: TryInto<T>,

Source§

fn try_into_bounded(self) -> Option<Bounded<T, N>>

Attempts to convert self into a Bounded using N bits. Read more