Struct WafMap 

pub struct WafMap { /* private fields */ }

The WAF object representation of a value of type WafObjectType::Map

Implementations

impl WafMap

pub const fn is_valid(&self) -> bool

Returns true if this WafMap is indeed WafObjectType::Map.

pub fn as_object(&self) -> &WafObject

Returns a reference to this value as a WafObject.

pub fn new(nb_entries: u64) -> Self

Creates a new WafMap with the provided size. All values in the map are initialized to an invalid WafObject instance with a blank key.

Panics

Panics when the provided nbEntries is larger than what the current platform can represent in an usize. This can only happen on platforms where usize is 32-bit wide.

pub fn len(&self) -> usize

Returns the length of this WafMap.

Panics

Panics if the map is larger than usize::MAX elements. This can only happen on platforms where usize is 32-bit wide.

pub fn is_empty(&self) -> bool

Returns true if this WafMap is empty.

pub fn iter(&self) -> impl Iterator<Item = &Keyed<WafObject>>

Returns an iterator over the Keyed<WafObject>s in this WafMap.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Keyed<WafObject>>

Returns a mutable iterator over the Keyed<WafObject>s in this WafMap.

pub fn get(&self, key: &[u8]) -> Option<&Keyed<WafObject>>

Returns a reference to the Keyed<WafObject> with the provided key, if one exists.

If multiple such objects exist in the receiver, the first match is returned.

pub fn get_mut(&mut self, key: &[u8]) -> Option<&mut Keyed<WafObject>>

Returns a mutable reference to the Keyed<WafObject> with the provided key, if one exists.

If multiple such objects exist in the receiver, the first match is returned.

pub fn get_str(&self, key: &str) -> Option<&Keyed<WafObject>>

Returns a reference to the Keyed<WafObject> with the provided key, if one exists.

pub fn get_str_mut(&mut self, key: &str) -> Option<&mut Keyed<WafObject>>

Returns a mutable reference to the Keyed<WafObject> with the provided key, if one exists.

Trait Implementations

impl AsMut<[Keyed<WafObject>]> for WafMap

fn as_mut(&mut self) -> &mut [Keyed<WafObject>]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[Keyed<WafObject>]> for WafMap

fn as_ref(&self) -> &[Keyed<WafObject>]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<_ddwaf_object> for WafMap

fn as_ref(&self) -> &ddwaf_object

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for WafMap

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

Formats the value using the given formatter.

impl Default for WafMap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WafMap

fn deserialize<D>(deserializer: D) -> Result<WafMap, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for WafMap

fn drop(&mut self)

Executes the destructor for this type.

impl<K: AsRef<[u8]>, V: Into<WafObject>, const N: usize> From<[(K, V); N]> for WafMap

fn from(vals: [(K, V); N]) -> Self

Converts to this type from the input type.

impl Index<usize> for WafMap

type Output = Keyed<WafObject>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for WafMap

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for WafMap

type Item = Keyed<WafObject>

The type of the elements being iterated over.

type IntoIter = WafIter<<WafMap as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: AsRef<ddwaf_object>> PartialEq<T> for WafMap

fn eq(&self, other: &T) -> 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 Serialize for WafMap

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<WafObject> for WafMap

type Error = ObjectTypeError

The type returned in the event of a conversion error.

fn try_from(obj: WafObject) -> Result<Self, Self::Error>

Performs the conversion.

impl TypedWafObject for WafMap

const TYPE: WafObjectType = WafObjectType::Map

The associated WafObjectType constant corresponding to the typed object’s type discriminator.