Struct JsonValue

Source

pub struct JsonValue { /* private fields */ }

Expand description

Native JSON payload stored as a first-class crate::Value.

JsonValue validates once at construction and deserialization so every engine layer can assume a finite JSON data-model value whose strings and container cardinalities stay inside the implementation-defined GQL caps.

Implementations§

Source §

impl JsonValue

Source

pub fn new(value: SerdeJsonValue) -> CoreResult<Self>

Build a validated JSON value from an owned serde-json value.

Source

pub fn parse_str(text: &str) -> CoreResult<Self>

Parse and validate a JSON value from text.

§Errors

Returns CoreError::JsonParse when text is not valid JSON, or the usual value-limit errors when the parsed value exceeds engine caps.

Source

pub fn as_serde(&self) -> &SerdeJsonValue

Borrow the underlying serde-json value.

Source

pub fn as_arc(&self) -> Arc<SerdeJsonValue>

Clone the shared JSON storage.

Source

pub fn to_canonical_string(&self) -> String

Return a stable compact JSON rendering with object keys sorted.

Source

pub fn json_type_name(&self) -> &'static str

Return the JSON data-model type name.

Source

pub fn contains(&self, candidate: &Self) -> bool

Return true when this JSON value recursively contains candidate.

Objects contain candidates whose keys are present and whose values are themselves contained. Arrays contain array candidates when each candidate element is contained by at least one target element. A scalar or object candidate also matches any containing target array element.

Source

pub fn path_exists(&self, path: &[JsonPathSelector]) -> bool

Return true when every selector in path resolves inside this value.

Stored-value shape mismatches return false. This makes the helper useful for heterogeneous graph scans where one malformed document should not abort the entire candidate search.

Source

pub fn path_value(&self, path: &[JsonPathSelector]) -> Option<Self>

Return the JSON subvalue selected by path.

Stored-value shape mismatches return None. A selected JSON null still returns Some(JsonValue), which lets callers distinguish present null values from absent paths.

Source

pub fn path_value_ref( &self, path: &[JsonPathSelector], ) -> Option<JsonValueRef<'_>>

Borrow the JSON subvalue selected by path.

Stored-value shape mismatches return None. A selected JSON null still returns Some(JsonValueRef), which lets callers distinguish present null values from absent paths without cloning the subvalue.

Source

pub fn path_contains(&self, path: &[JsonPathSelector], candidate: &Self) -> bool

Return true when path selects a JSON value that contains candidate.

Stored-value shape mismatches return false, matching Self::path_exists. Containment follows Self::contains semantics on the selected subvalue.

Source

pub fn merge_patch(&self, patch: &Self) -> CoreResult<Self>

Return the result of applying an RFC 7396 JSON Merge Patch document.

The operation is copy-on-write: this value and patch are left unchanged, and the merged result is validated as a fresh JsonValue.

§Errors

Returns the usual value-limit errors if the merged result exceeds engine caps.

Source

pub fn apply_patch(&self, patch: &Self) -> CoreResult<Self>

Return the result of applying an RFC 6902 JSON Patch document.

The operation is atomic from the caller’s perspective: this value and patch are left unchanged, and an invalid patch returns an error without exposing any intermediate document state.

§Errors

Returns CoreError::JsonPatch when the patch document is malformed or an operation fails. Returns the usual value-limit errors if the patched result exceeds engine caps.