Struct FieldPath 

pub struct FieldPath(pub Vec<FieldPathPart>);

A path for pure field extraction, with no execution required.

This is a validated subset of Idiom that only contains parts that can be extracted synchronously from a Value without database access or expression evaluation.

Supported patterns:

• a - simple field
• a.b.c - nested fields
• a[0] - array index
• a[$] - last element
• a[0].b.c - mixed

Examples

use surrealdb::exec::FieldPath;

// Simple field
let path = FieldPath::field("name");

// Convert from idiom (may fail for complex idioms)
let idiom = syn::idiom("user.address.city").unwrap();
let path = FieldPath::try_from(&idiom)?;

Tuple Fields

0: Vec<FieldPathPart>

Implementations

impl FieldPath

pub fn field(name: impl Into<String>) -> Self

Create a simple single-field path.

pub fn is_empty(&self) -> bool

Check if this is an empty path.

pub fn len(&self) -> usize

Get the number of parts in this path.

pub fn extract<'a>(&self, value: &'a Value) -> Cow<'a, Value>

Extract the value at this path from a record. Returns Value::None if the path doesn’t exist.

Borrows into the input wherever the path is pure navigation (object fields, array/set element access), so the common case — a sort key like a.b.c — never clones the record. An owned value is produced only for synthesised results (field projection over an array/set, missing paths) or when descending through one.

Trait Implementations

impl Clone for FieldPath

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldPath

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

Formats the value using the given formatter.

impl Display for FieldPath

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

Formats the value using the given formatter.

impl Eq for FieldPath

impl Hash for FieldPath

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

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 PartialEq for FieldPath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FieldPath