Struct dxr_shared::Value

pub struct Value { /* private fields */ }

XML-RPC value type

The Value type is the Rust equivalent of valid XML-RPC values. It provides constructors from all compatible primitive types, (de)serialization support from and to XML-RPC value strings, and fallible conversion from and to Value with implementations of the TryFromValue and TryToValue traits.

Note that the constructors for all primitive value types are infallible, except for the string type, which can fail if the string argument fails to be escaped properly for XML.

In general, using methods from the fallible TryFromValue and TryToValue conversion traits is recommended, as they provide a consistent interface across all types, including Vec, arrays, slices, tuples, HashMaps, and even custom structs, when using the TryFromValue and TryToValue derive macros.

Implementations

impl Value

pub fn i4(value: i32) -> Value

constructor for <i4> values (signed 32-bit integers)

pub fn i8(value: i64) -> Value

Available on crate feature i8 only.

constructor for <i8> values (signed 64-bit integers)

This type is not part of the original XML-RPC spec, but is a widely used extension. Support for <i8> values is optional and can be enabled with the i8 crate feature.

pub fn boolean(value: bool) -> Value

constructor for <boolean> values (true or false)

pub fn string(value: &str) -> Value

constructor for <string> values

Note that this constructor handles string escaping for safe inclusion in XML internally. Using the TryFromValue and TryToValue trait implementations for String and &str is recommended, as those handle escaping and un-escaping automatically.

pub fn double(value: f64) -> Value

constructor for <double> values (64-bit floating point numbers)

pub fn datetime(value: DateTime<Utc>) -> Value

constructor for <dateTime.iso8601> values (date & time)

Note that the date & time format used by XML-RPC does not include sub-second precision, nor any timezone information. This crate assumes Utc is used on the server.

pub fn base64(value: Vec<u8>) -> Value

constructor for <base64> values (base64-encoded, arbitrary bytes)

pub fn nil() -> Value

Available on crate feature nil only.

constructor for the <nil/> value (empty / missing value)

This type is not part of the original XML-RPC spec, but is a widely used extension. Support for <nil> values is optional and can be enabled with the nil crate feature.

If enabled, this type is used to emulate support for optional values in XML-RPC, by mapping Rust Options to either their contained Value, or to a <nil> value. This is consistent with the XML-RPC implementation in the Python xmlrpc standard library module.

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<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Value> 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 Serialize for Value

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFromParams for Value

fn try_from_params(values: &[Value]) -> Result<Self, DxrError>

conversion method from XML-RPC method call argument lists to Rust types

impl TryFromValue for Value

fn try_from_value(value: &Value) -> Result<Value, DxrError>

fallible conversion method from an XML-RPC value into the target type

impl TryToParams for &Value

fn try_to_params(&self) -> Result<Vec<Value>, DxrError>

conversion method from types into XML-RPC method call argument lists

impl TryToParams for Value

fn try_to_params(&self) -> Result<Vec<Value>, DxrError>

conversion method from types into XML-RPC method call argument lists

impl TryToValue for Value

fn try_to_value(&self) -> Result<Value, DxrError>

fallible conversion method from types into XML-RPC values

impl StructuralPartialEq for Value