Struct Limit

pub struct Limit<'a> {
    pub family: NfFamily,
    pub table: Cow<'a, str>,
    pub name: Cow<'a, str>,
    pub handle: Option<u32>,
    pub rate: Option<u32>,
    pub per: Option<NfTimeUnit>,
    pub burst: Option<u32>,
    pub unit: Option<LimitUnit>,
    pub inv: Option<bool>,
}

This object represents a named limit.

A limit uses a [token bucket](Token bucket) filter to match packets:

• only until its rate is exceeded; or
• only after its rate is exceeded, if defined as an over limit.

(Limit): https://wiki.nftables.org/wiki-nftables/index.php/Limits (Token bucket): https://en.wikipedia.org/wiki/Token_bucket

Fields

family: NfFamily

The table’s family.

table: Cow<'a, str>

The table’s name.

name: Cow<'a, str>

The limit’s name.

handle: Option<u32>

The limit’s handle. In input, it is used by the delete command only.

rate: Option<u32>

The limit’s rate value.

per: Option<NfTimeUnit>

Time unit to apply the limit to, e.g. “week”, “day”, “hour”, etc.

If omitted, defaults to “second”.

burst: Option<u32>

The limit’s burst value. If omitted, defaults to 0.

unit: Option<LimitUnit>

Unit of rate and burst values. If omitted, defaults to “packets”.

inv: Option<bool>

If true, match if limit was exceeded. If omitted, defaults to false.

Trait Implementations

impl<'a> Clone for Limit<'a>

fn clone(&self) -> Limit<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Limit<'a>

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

Formats the value using the given formatter.

impl Default for Limit<'_>

Default limit named “mylimit”.

fn default() -> Self

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for Limit<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> JsonSchema for Limit<'a>

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl<'a> PartialEq for Limit<'a>

fn eq(&self, other: &Limit<'a>) -> 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<'a> Serialize for Limit<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Limit<'a>

impl<'a> StructuralPartialEq for Limit<'a>