Struct WafString 

pub struct WafString { /* private fields */ }

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

Implementations

impl WafString

pub fn is_valid(&self) -> bool

Returns true if this WafString is indeed WafObjectType::String.

pub fn as_object(&self) -> &WafObject

Returns a reference to this value as a WafObject.

pub fn new(val: impl AsRef<[u8]>) -> Option<Self>

Creates a new WafString with the provided value. Only returns none if the string is larger than u32::MAX bytes.

Panics

Panics if memory allocation fails (out of memory).

pub fn new_literal(val: impl Into<&'static [u8]>) -> Self

Creates a new WafString with the provided static value.

Panics

Panics if the string is larger than u32::MAX bytes.

pub fn len(&self) -> u32

Returns the length of this WafString, in bytes.

pub fn is_empty(&self) -> bool

Returns true if this WafString is empty.

pub fn as_bytes(&self) -> &[u8]

Returns a slice of the bytes from this WafString.

pub fn as_str(&self) -> Result<&str, Utf8Error>

Returns a string slice from this WafString.

Errors

Returns an error if the underlying data is not a valid UTF-8 string, under the same conditions as std::str::from_utf8.

Trait Implementations

impl AsRef<_ddwaf_object> for WafString

fn as_ref(&self) -> &ddwaf_object

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

impl Clone for WafString

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WafString

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

Formats the value using the given formatter.

impl Default for WafString

fn default() -> Self

Returns the “default value” for a type.

impl Drop for WafString

fn drop(&mut self)

Executes the destructor for this type.

impl<T: AsRef<[u8]>> From<T> for WafString

fn from(val: T) -> Self

Converts to this type from the input type.

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

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 WafString

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 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 TypedWafObject for WafString

const TYPE: WafObjectType = WafObjectType::String

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