Struct ValueRef 

pub struct ValueRef<T = Value>(/* private fields */)
where
    T: 'static;

A literal value which may be passed to a component.

This is a reference to a value owned by an Arc<serde_json::Value>.

The value is projected to a subfield of the Arc when accessed.

This is useful for avoiding cloning the value when accessing nested fields.

The value is projected to a subfield of the Arc when accessed.

Implementations

impl ValueRef

pub fn new(value: Value) -> ValueRef

pub fn redacted<'a>(&'a self, secrets: &'a Secrets) -> RedactedValue<'a>

Return a redacted version of this value ref for printing.

pub fn is_truthy(&self) -> bool

pub fn path(&self, path: &str) -> Option<ValueRef>

Access an object field by name.

pub fn index(&self, index: usize) -> Option<ValueRef>

Access an array element by index.

pub fn resolve_json_path(&self, json_path: &JsonPath) -> Option<ValueRef>

Access value using a JSON path

pub fn as_object(&self) -> Option<ValueRef<Map<String, Value>>>

Cast to an object if this value is an object

pub fn as_array(&self) -> Option<ValueRef<Vec<Value>>>

Cast to an array if this value is an array

pub fn value(&self) -> &Value

pub fn clone_value(&self) -> Value

Clone the underlying JSON value

pub fn deserialize<T>(&self) -> Result<T, Error>

where T: DeserializeOwned,

Deserialize the value into a specific type

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

Get the value as a boolean if it is one

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

Get the value as a string if it is one

pub fn as_number(&self) -> Option<&Number>

Get the value as a number if it is one

pub fn is_null(&self) -> bool

Check if the value is null

impl ValueRef<Vec<Value>>

pub fn iter(&self) -> impl Iterator<Item = ValueRef>

pub fn get(&self, index: usize) -> Option<ValueRef>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl ValueRef<Map<String, Value>>

pub fn iter(&self) -> impl Iterator<Item = (&str, ValueRef)>

pub fn get(&self, key: &str) -> Option<ValueRef>

pub fn contains_key(&self, key: &str) -> bool

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

Trait Implementations

impl AsRef<Value> for ValueRef

fn as_ref(&self) -> &Value

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

impl<T> Clone for ValueRef<T>

where T: Clone + 'static,

fn clone(&self) -> ValueRef<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ValueRef<T>

where T: Debug,

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

Formats the value using the given formatter.

impl Default for ValueRef

fn default() -> ValueRef

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ValueRef

fn deserialize<D>( deserializer: D, ) -> Result<ValueRef, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for ValueRef

where T: Into<Value>,

fn from(value: T) -> ValueRef

Converts to this type from the input type.

impl<T> Hash for ValueRef<T>

where T: Hash + 'static,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for ValueRef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl<T> PartialEq for ValueRef<T>

where T: PartialEq + 'static,

fn eq(&self, other: &ValueRef<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 ValueRef

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for ValueRef<T>

where T: Eq + 'static,

impl<T> StructuralPartialEq for ValueRef<T>

where T: 'static,