Enum php_literal_parser::Value

pub enum Value {
    Bool(bool),
    Int(i64),
    Float(f64),
    String(String),
    Array(HashMap<Key, Value>),
    Null,
}

A php value, can be either a bool, int, float, string, an array or null

note that in php all arrays are associative and thus represented by a map in rust.

You can convert a Value into a regular rust type by pattern matching or using the into_ functions.

Indexing

If the value is a php array, you can directly index into the Value, this will null if the Value is not an array or the key is not found

let value = Value::Array(hashmap!{
    "key".into() => "value".into(),
    10.into() => false.into()
});
assert_eq!(value["key"], "value");
assert_eq!(value[10], false);
assert!(value["not"]["found"].is_null());

Variants

Bool(bool)

Int(i64)

Float(f64)

String(String)

Array(HashMap<Key, Value>)

Null

Implementations

impl Value

pub fn is_bool(&self) -> bool

Check if the value is a bool

pub fn is_int(&self) -> bool

Check if the value is an integer

pub fn is_float(&self) -> bool

Check if the value is a float

pub fn is_string(&self) -> bool

Check if the value is a string

pub fn is_array(&self) -> bool

Check if the value is an array

pub fn is_null(&self) -> bool

Check if the value is null

pub fn into_bool(self) -> Option<bool>

Convert the value into a bool if it is one

pub fn into_int(self) -> Option<i64>

Convert the value into a int if it is one

pub fn into_float(self) -> Option<f64>

Convert the value into a float if it is one

pub fn into_string(self) -> Option<String>

Convert the value into a string if it is one

pub fn into_hashmap(self) -> Option<HashMap<Key, Value>>

Convert the value into a hashmap if it is one

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

Get the value as &str if it is a string

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

Get the value as i64 if it is an int

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

Get the value as f64 if it is a float

pub fn iter(&self) -> impl Iterator<Item = (&Key, &Value)>

Iterate over array key and value pairs if it is an array

pub fn keys(&self) -> impl Iterator<Item = &Key>

Iterate over array keys if it is an array

pub fn values(&self) -> impl Iterator<Item = &Value>

Iterate over array values if it is an array

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl From<&str> for Value

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<HashMap<Key, Value>> for Value

fn from(value: HashMap<Key, Value>) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(value: i64) -> Self

Converts to this type from the input type.

impl<Q> Index<&Q> for Value

where Key: Borrow<Q>, Q: Eq + Hash + ?Sized,

type Output = Value

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Key> for Value

type Output = Value

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<i64> for Value

type Output = Value

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl PartialEq<&str> for Value

fn eq(&self, other: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for Value

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<bool> for Value

fn eq(&self, other: &bool) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<f64> for Value

fn eq(&self, other: &f64) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i64> for Value

fn eq(&self, other: &i64) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Value