Struct WafObject 

pub struct WafObject { /* private fields */ }

The low-level representation of an arbitrary WAF object.

It is usually converted to a TypedWafObject by calling WafObject::as_type.

Implementations

impl WafObject

pub fn from_json(json: impl AsRef<[u8]>) -> Option<WafOwned<Self>>

Creates a new WafObject from a JSON string.

This function is not intended to be used with un-trusted/adversarial input. The typical use-case is to facilitate parsing rulesets for use with crate::builder::Builder::add_or_update_config.

Returns

Returns None if parsing the JSON string into a WafObject was not possible, or if the input JSON string is larger than u32::MAX bytes.

pub fn get_type(&self) -> WafObjectType

Returns the WafObjectType of the underlying value.

Returns WafObjectType::Invalid if the underlying value’s type is not set to a known, valid WafObjectType value.

pub fn as_type<T: TypedWafObject>(&self) -> Option<&T>

Returns a reference to this value as a T if its type corresponds.

pub fn as_type_mut<T: TypedWafObject>(&mut self) -> Option<&mut T>

Returns a mutable reference to this value as a T if its type corresponds.

pub fn is_valid(&self) -> bool

Returns true if this WafObject is not WafObjectType::Invalid, meaning it can be converted to one of the TypedWafObject implementations.

pub fn to_u64(&self) -> Option<u64>

Returns the value of this WafObject as a u64 if its type is WafObjectType::Unsigned.

pub fn to_i64(&self) -> Option<i64>

Returns the value of this WafObject as a i64 if its type is WafObjectType::Signed (or WafObjectType::Unsigned with a value that can be represented as an i64).

pub fn to_f64(&self) -> Option<f64>

Returns the value of this WafObject as a f64 if its type is WafObjectType::Float.

pub fn to_bool(&self) -> Option<bool>

Returns the value of this WafObject as a bool if its type is WafObjectType::Bool.

pub fn to_str(&self) -> Option<&str>

Returns the value of this WafObject as a &str if its type is WafObjectType::String, and the value is valid UTF-8.

Trait Implementations

impl AsRef<_ddwaf_object> for WafObject

fn as_ref(&self) -> &ddwaf_object

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

impl Debug for WafObject

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

Formats the value using the given formatter.

impl Default for WafObject

fn default() -> WafObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WafObject

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for WafObject

fn drop(&mut self)

Executes the destructor for this type.

impl From<&[u8]> for WafObject

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for WafObject

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<()> for WafObject

fn from((): ()) -> Self

Converts to this type from the input type.

impl<T: TypedWafObject> From<T> for WafObject

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<bool> for WafObject

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for WafObject

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for WafObject

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for WafObject

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<u32> for WafObject

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for WafObject

fn from(value: u64) -> Self

Converts to this type from the input type.

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

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 WafObject

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 WafArray

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 TryFrom<WafObject> for WafBool

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 TryFrom<WafObject> for WafFloat

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 TryFrom<WafObject> for WafInvalid

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 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 TryFrom<WafObject> for WafNull

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 TryFrom<WafObject> for WafSigned

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 TryFrom<WafObject> for WafString

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 TryFrom<WafObject> for WafUnsigned

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.