Skip to main content

ValidationLimits

Struct ValidationLimits 

Source
pub struct ValidationLimits {
    pub cache_size: usize,
    pub max_relays_per_group: usize,
    pub max_messages_per_group: usize,
    pub max_group_name_length: usize,
    pub max_group_description_length: usize,
    pub max_admins_per_group: usize,
    pub max_relays_per_welcome: usize,
    pub max_admins_per_welcome: usize,
    pub max_relay_url_length: usize,
}
Expand description

Configurable validation limits for memory storage.

This struct allows customization of the various limits used to prevent memory exhaustion attacks. All limits have sensible defaults that can be overridden using the builder pattern.

§Example

use mdk_memory_storage::ValidationLimits;

let limits = ValidationLimits::default()
    .with_cache_size(2000)
    .with_max_messages_per_group(5000)
    .with_max_relays_per_group(50);

Fields§

§cache_size: usize

Maximum number of items in each LRU cache

§max_relays_per_group: usize

Maximum number of relays allowed per group

§max_messages_per_group: usize

Maximum number of messages stored per group

§max_group_name_length: usize

Maximum length of a group name in bytes

§max_group_description_length: usize

Maximum length of a group description in bytes

§max_admins_per_group: usize

Maximum number of admin pubkeys per group

§max_relays_per_welcome: usize

Maximum number of relays in a welcome message

§max_admins_per_welcome: usize

Maximum number of admin pubkeys in a welcome message

§max_relay_url_length: usize

Maximum length of a relay URL in bytes

Implementations§

Source§

impl ValidationLimits

Source

pub fn new() -> Self

Creates a new ValidationLimits with default values.

Source

pub fn with_cache_size(self, size: usize) -> Self

Sets the maximum number of items in each LRU cache.

§Panics

Panics if size is 0.

Source

pub fn with_max_relays_per_group(self, limit: usize) -> Self

Sets the maximum number of relays allowed per group.

§Panics

Panics if limit is 0.

Source

pub fn with_max_messages_per_group(self, limit: usize) -> Self

Sets the maximum number of messages stored per group.

§Panics

Panics if limit is 0.

Source

pub fn with_max_group_name_length(self, limit: usize) -> Self

Sets the maximum length of a group name in bytes.

§Panics

Panics if limit is 0.

Source

pub fn with_max_group_description_length(self, limit: usize) -> Self

Sets the maximum length of a group description in bytes.

§Panics

Panics if limit is 0.

Source

pub fn with_max_admins_per_group(self, limit: usize) -> Self

Sets the maximum number of admin pubkeys per group.

§Panics

Panics if limit is 0.

Source

pub fn with_max_relays_per_welcome(self, limit: usize) -> Self

Sets the maximum number of relays in a welcome message.

§Panics

Panics if limit is 0.

Source

pub fn with_max_admins_per_welcome(self, limit: usize) -> Self

Sets the maximum number of admin pubkeys in a welcome message.

§Panics

Panics if limit is 0.

Source

pub fn with_max_relay_url_length(self, limit: usize) -> Self

Sets the maximum length of a relay URL in bytes.

§Panics

Panics if limit is 0.

Trait Implementations§

Source§

impl Clone for ValidationLimits

Source§

fn clone(&self) -> ValidationLimits

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ValidationLimits

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ValidationLimits

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for ValidationLimits

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V