Struct ShapeError 

pub struct ShapeError {
    pub path: String,
    pub message: String,
}

A failed ConfigShape::from_value, carrying where.

The host validates the tree against the schema before a guest ever sees it, so in practice a guest’s from_value fails only on a value the host could not have checked — a type the schema calls a string but the guest wants to interpret further (an enum spelled as a string, a path, a duration). Those are exactly the cases where a path matters, so it is carried rather than dropped.

Display renders path: message, or just message at the root.

Examples

use lattice_plugin_sdk::shape::{ConfigShape, Value};

let v = Value::List(vec![Value::Int(1), Value::Str("two".into())]);
let err = <Vec<i64>>::from_value(&v).unwrap_err();
assert_eq!(err.path, "[1]");
assert_eq!(err.to_string(), "[1]: expected integer, got string");

Fields

path: String

Where the failure is, outermost segment first: field names joined with ., list indices as [i] with no dot before them (templates[2].target.file). Empty when the root value itself failed.

message: String

What went wrong at that location, e.g. expected integer, got string or required field is missing.

Implementations

impl ShapeError

pub fn new(message: impl Into<String>) -> Self

An error at the root (empty path); callers above it prepend their segment with under.

pub fn under(self, segment: &str) -> Self

Prepend a segment as this error unwinds back up the walk. The derive calls it per field, so a leaf failure arrives at the top with the full path assembled and no field having had to know where it lives.

A . separator is inserted unless the existing path begins with an index segment ([), so indices attach directly to their list.

Examples

use lattice_plugin_sdk::shape::ShapeError;

// Segments are discovered inside-out, so they are prepended.
let e = ShapeError::new("boom").under("file").under("[0]").under("targets");
assert_eq!(e.path, "targets[0].file");

Trait Implementations

impl Clone for ShapeError

fn clone(&self) -> ShapeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeError

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

Formats the value using the given formatter.

impl Display for ShapeError

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

Formats the value using the given formatter.

impl Eq for ShapeError

impl Error for ShapeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for ShapeError

fn eq(&self, other: &ShapeError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ShapeError