Skip to content

value

The value module is auto-imported — no import statement needed.

FunctionSignatureDescription
get(Value, String) -> Result[Value, String]Get a field from a Value object by key. Returns err if missing.
as_string(Value) -> Result[String, String]Extract a String from a Value. Returns err if not a Str.
as_int(Value) -> Result[Int, String]Extract an Int from a Value. Returns err if not an Int.
as_float(Value) -> Result[Float, String]Extract a Float from a Value. Returns err if not a Float.
as_bool(Value) -> Result[Bool, String]Extract a Bool from a Value. Returns err if not a Bool.
as_array(Value) -> Result[List[Value], String]Extract a List[Value] from a Value. Returns err if not an Array.
str(String) -> ValueCreate a Value from a String.
int(Int) -> ValueCreate a Value from an Int.
float(Float) -> ValueCreate a Value from a Float.
bool(Bool) -> ValueCreate a Value from a Bool.
object(List[(String, Value)]) -> ValueCreate a Value object from a list of key-value pairs.
array(List[Value]) -> ValueCreate a Value array from a list of Values.
null() -> ValueCreate a null Value.
pick(Value, List[String]) -> ValuePick specific keys from an Object, discarding the rest.
omit(Value, List[String]) -> ValueRemove specific keys from an Object.
merge(Value, Value) -> ValueMerge two Objects. Keys from b override keys from a.
to_camel_case(Value) -> ValueConvert Object keys from snake_case to camelCase.
to_snake_case(Value) -> ValueConvert Object keys from camelCase to snake_case.
stringify(Value) -> StringConvert a Value to a JSON-like string representation.

value.get(v: Value, key: String) -> Result[Value, String]

Section titled “value.get(v: Value, key: String) -> Result[Value, String]”

Get a field from a Value object by key. Returns err if missing.

value.as_string(v: Value) -> Result[String, String]

Section titled “value.as_string(v: Value) -> Result[String, String]”

Extract a String from a Value. Returns err if not a Str.

value.as_int(v: Value) -> Result[Int, String]

Section titled “value.as_int(v: Value) -> Result[Int, String]”

Extract an Int from a Value. Returns err if not an Int.

value.as_float(v: Value) -> Result[Float, String]

Section titled “value.as_float(v: Value) -> Result[Float, String]”

Extract a Float from a Value. Returns err if not a Float.

value.as_bool(v: Value) -> Result[Bool, String]

Section titled “value.as_bool(v: Value) -> Result[Bool, String]”

Extract a Bool from a Value. Returns err if not a Bool.

value.as_array(v: Value) -> Result[List[Value], String]

Section titled “value.as_array(v: Value) -> Result[List[Value], String]”

Extract a List[Value] from a Value. Returns err if not an Array.

Create a Value from a String.

Create a Value from an Int.

Create a Value from a Float.

Create a Value from a Bool.

value.object(pairs: List[(String, Value)]) -> Value

Section titled “value.object(pairs: List[(String, Value)]) -> Value”

Create a Value object from a list of key-value pairs.

Create a Value array from a list of Values.

Create a null Value.

value.pick(v: Value, keys: List[String]) -> Value

Section titled “value.pick(v: Value, keys: List[String]) -> Value”

Pick specific keys from an Object, discarding the rest.

value.omit(v: Value, keys: List[String]) -> Value

Section titled “value.omit(v: Value, keys: List[String]) -> Value”

Remove specific keys from an Object.

Merge two Objects. Keys from b override keys from a.

Convert Object keys from snake_case to camelCase.

Convert Object keys from camelCase to snake_case.

Convert a Value to a JSON-like string representation.