Struct ValidateOptions 

pub struct ValidateOptions {
    pub root_id: String,
    pub require_root: bool,
    pub allow_dangling_children: bool,
    pub check_component_types: bool,
    pub check_required_props: bool,
    pub check_prop_types: bool,
    pub check_envelope: bool,
    pub check_bindings: bool,
    pub check_binding_syntax: bool,
    pub max_depth: usize,
    pub max_function_call_depth: usize,
}

What the validator should demand of a payload.

Fields

root_id: String

Id the tree root must have. Defaults to ROOT_ID.

require_root: bool

Whether a component with the root id must be present.

allow_dangling_children: bool

Whether child references may point outside this payload.

check_component_types: bool

Whether component types must exist in the catalog.

Turned off automatically when the catalog defines no components at all, since that means the caller has not supplied one.

check_required_props: bool

Whether required properties are enforced.

check_prop_types: bool

Whether property values must match the JSON type the catalog declares.

Only properties the catalog pins to one type are checked, and a value the renderer resolves — a {"path": …} binding or a function call — is never checked, because its type on the wire says nothing about the type it will have. See PropType.

check_envelope: bool

Whether message envelopes must satisfy the v0.9 wire contract.

Applies only to the raw-message entry points (Validator::validate_json_messages and Validator::validate_messages); the component entry points are handed components directly and have no envelope to check.

check_bindings: bool

Whether data bindings are resolved against the data model, and whether relative paths are required to sit inside a list template.

check_binding_syntax: bool

Whether absolute binding paths must be syntactically valid JSON Pointers.

Separate from ValidateOptions::check_bindings because it needs no data model and cannot produce a false positive: a malformed escape can never resolve, whatever the data turns out to be.

max_depth: usize

Deepest nesting accepted, for both the component graph and the raw JSON.

Defaults to MAX_DEPTH. Raising it is safe here — every walk in this crate is iterative — but a renderer on the other end may not be, and a tree this deep is a generation failure rather than a design.

max_function_call_depth: usize

Deepest chain of function calls accepted, counting nesting through args.

Defaults to MAX_FUNCTION_CALL_DEPTH.

Implementations

impl ValidateOptions

pub fn full_surface() -> Self

The full contract, for a payload that creates a surface.

pub fn incremental_update() -> Self

The relaxed contract, for a payload that updates an existing surface.

The root and the referenced components may already live on the renderer, so their absence from this payload is not an error.

pub fn with_root_id(self, root_id: impl Into<String>) -> Self

Overrides the root component id.

pub fn with_max_depth(self, max_depth: usize) -> Self

Overrides the maximum nesting depth.

Trait Implementations

impl Clone for ValidateOptions

fn clone(&self) -> ValidateOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidateOptions

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

Formats the value using the given formatter.

impl Default for ValidateOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ValidateOptions

impl PartialEq for ValidateOptions

fn eq(&self, other: &ValidateOptions) -> 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 StructuralPartialEq for ValidateOptions