Struct Properties 

pub struct Properties { /* private fields */ }

A wrapper around serde_json::Value for properties-style configuration data.

This struct provides a type-safe interface for working with properties configuration data retrieved from Apollo. Properties are typically stored as key-value pairs where all values are strings that can be parsed into various types.

Thread Safety

This struct is Clone and Debug, making it easy to work with in concurrent environments. The underlying serde_json::Value is also thread-safe.

Examples

use serde_json::json;
use apollo_client::namespace::properties::Properties;

let props_data = json!({
    "database.host": "localhost",
    "database.port": "5432",
    "database.ssl": "true"
});

let properties = Properties::from(props_data);

Implementations

impl Properties

pub fn get_property<T: FromStr>(&self, key: &str) -> Option<T>

Gets a property value and attempts to parse it into the specified type.

This is a generic method that can parse string values into any type that implements FromStr. It first retrieves the value as a string, then attempts to parse it into the target type.

Type Parameters

• T - The target type to parse into. Must implement std::str::FromStr.

Arguments

• key - The property key to retrieve

Returns

• Some(T) - The parsed value if the key exists and parsing succeeds
• None - If the key doesn’t exist, the value is not a string, or parsing fails

Examples

use serde_json::json;
use apollo_client::namespace::properties::Properties;

let props_data = json!({"timeout": "30", "retries": "3"});
let properties = Properties::from(props_data);

let timeout: Option<u32> = properties.get_property("timeout");
let retries: Option<i32> = properties.get_property("retries");

impl Properties

pub fn get_string(&self, key: &str) -> Option<String>

Get a property from the cache as a string.

This method retrieves a property value and returns it as a String. It’s a convenience method that wraps get_property::<String>().

Arguments

• key - The key to get the property for.

Returns

• Some(String) - The property value as a string if it exists
• None - If the key doesn’t exist or the value cannot be converted to a string

Examples

use serde_json::json;
use apollo_client::namespace::properties::Properties;

let props_data = json!({"app.name": "MyApp"});
let properties = Properties::from(props_data);

let app_name = properties.get_string("app.name");
assert_eq!(app_name, Some("MyApp".to_string()));

pub fn get_int(&self, key: &str) -> Option<i64>

Get a property from the cache as an integer.

This method retrieves a property value and attempts to parse it as an i64. It’s a convenience method that wraps get_property::<i64>().

Arguments

• key - The key to get the property for.

Returns

• Some(i64) - The property value as an integer if it exists and can be parsed
• None - If the key doesn’t exist or the value cannot be parsed as an integer

Examples

use serde_json::json;
use apollo_client::namespace::properties::Properties;

let props_data = json!({"server.port": "8080"});
let properties = Properties::from(props_data);

let port = properties.get_int("server.port");
assert_eq!(port, Some(8080));

pub fn get_float(&self, key: &str) -> Option<f64>

Get a property from the cache as a float.

This method retrieves a property value and attempts to parse it as an f64. It’s a convenience method that wraps get_property::<f64>().

Arguments

• key - The key to get the property for.

Returns

• Some(f64) - The property value as a float if it exists and can be parsed
• None - If the key doesn’t exist or the value cannot be parsed as a float

Examples

use serde_json::json;
use apollo_client::namespace::properties::Properties;

let props_data = json!({"timeout.seconds": "30.5"});
let properties = Properties::from(props_data);

let timeout = properties.get_float("timeout.seconds");
assert_eq!(timeout, Some(30.5));

pub fn get_bool(&self, key: &str) -> Option<bool>

Get a property from the cache as a boolean.

This method retrieves a property value and attempts to parse it as a bool. It’s a convenience method that wraps get_property::<bool>(). The parsing follows Rust’s standard boolean parsing rules (accepts “true”/“false”).

Arguments

• key - The key to get the property for.

Returns

• Some(bool) - The property value as a boolean if it exists and can be parsed
• None - If the key doesn’t exist or the value cannot be parsed as a boolean

Examples

use serde_json::json;
use apollo_client::namespace::properties::Properties;

let props_data = json!({"debug.enabled": "true"});
let properties = Properties::from(props_data);

let debug_enabled = properties.get_bool("debug.enabled");
assert_eq!(debug_enabled, Some(true));

Trait Implementations

impl Clone for Properties

fn clone(&self) -> Properties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Properties

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

Formats the value using the given formatter.

impl From<Properties> for JsValue

fn from(value: Properties) -> Self

Converts to this type from the input type.

impl From<Value> for Properties

Converts a serde_json::Value into a Properties instance.

This implementation allows for easy creation of Properties instances from raw JSON data, typically used by the namespace detection system. The JSON value is expected to be an object where keys are property names and values are the property values (typically strings).

Examples

use serde_json::json;
use apollo_client::namespace::properties::Properties;

let props_data = json!({
    "app.name": "MyApp",
    "app.version": "1.0.0"
});

let properties = Properties::from(props_data);

fn from(value: Value) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Properties

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Properties

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Properties

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Properties>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Properties

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Properties

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Properties

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Properties>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Properties

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Properties>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for Properties

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for Properties

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Properties]>

impl VectorIntoJsValue for Properties

fn vector_into_jsvalue(vector: Box<[Properties]>) -> JsValue

impl VectorIntoWasmAbi for Properties

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Properties]>) -> Self::Abi

impl WasmDescribe for Properties

fn describe()

impl WasmDescribeVector for Properties

fn describe_vector()

impl SupportsConstructor for Properties

impl SupportsInstanceProperty for Properties

impl SupportsStaticProperty for Properties