Struct FieldPath

pub struct FieldPath(/* private fields */);

Field path supporting up to 5 levels of nesting

Implementations

impl FieldPath

pub fn new(path: impl Into<String>) -> Result<Self, AppsyncError>

Creates a new field path from a string-like value

Arguments

• path - Field path as a string

Errors

Returns ValidationError if path exceeds 256 characters

Examples

let path = FieldPath::new("user.profile.name")?;

pub unsafe fn new_unchecked(path: impl Into<String>) -> Self

Creates a new field path from a string-like value without validation

Safety

This function skips validation of the field path. The caller must ensure:

• Path length does not exceed 256 characters
• Path contains valid field references only
• Path nesting depth does not exceed 5 levels

Examples

let path = unsafe { FieldPath::new_unchecked("user.name") };

pub fn eq<IFSB: IFSBValueMarker>(self, ifsb: IFSB) -> FieldFilter

Creates an equality filter

pub unsafe fn eq_unchecked<T: Serialize>(self, value: T) -> FieldFilter

Creates an equality filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string
• A boolean

pub fn ne<IFSB: IFSBValueMarker>(self, ifsb: IFSB) -> FieldFilter

Creates a not equal filter

pub unsafe fn ne_unchecked<T: Serialize>(self, value: T) -> FieldFilter

Creates a not equal filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string
• A boolean

pub fn le<IFS: IFSValueMarker>(self, ifs: IFS) -> FieldFilter

Creates a less than or equal filter

pub unsafe fn le_unchecked<T: Serialize>(self, value: T) -> FieldFilter

Creates a less than or equal filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string

pub fn lt<IFS: IFSValueMarker>(self, ifs: IFS) -> FieldFilter

Creates a less than filter

pub unsafe fn lt_unchecked<T: Serialize>(self, value: T) -> FieldFilter

Creates a less than filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string

pub fn ge<IFS: IFSValueMarker>(self, ifs: IFS) -> FieldFilter

Creates a greater than or equal filter

pub unsafe fn ge_unchecked<T: Serialize>(self, value: T) -> FieldFilter

Creates a greater than or equal filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string

pub fn gt<IFS: IFSValueMarker>(self, ifs: IFS) -> FieldFilter

Creates a greater than filter

pub unsafe fn gt_unchecked<T: Serialize>(self, value: T) -> FieldFilter

Creates a greater than filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string

pub fn contains<IFS: IFSValueMarker>(self, ifs: IFS) -> FieldFilter

Creates a contains filter for strings or arrays

pub unsafe fn contains_unchecked<T: Serialize>(self, value: T) -> FieldFilter

Creates a contains filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string

pub fn not_contains<IFS: IFSValueMarker>(self, ifs: IFS) -> FieldFilter

Creates a not contains filter for strings or arrays

pub unsafe fn not_contains_unchecked<T: Serialize>( self, value: T, ) -> FieldFilter

Creates a not contains filter from any serializable value

Safety

The caller must ensure the value serializes to either:

• A number
• A string

pub fn begins_with(self, value: impl Into<String>) -> FieldFilter

Creates a begins with filter for string fields

pub fn in_values<IFS: IFSValueMarker>( self, values: impl Into<FixedVec<IFS, 5>>, ) -> FieldFilter

Creates an IN filter accepting up to 5 values

Examples

let path = FieldPath::new("user.id")?;
let filter = path.in_values(["id1", "id2", "id3"]);

pub unsafe fn in_values_unchecked<T: Serialize>( self, values: impl Into<FixedVec<T, 5>>, ) -> FieldFilter

Creates an IN filter from any array of up to 5 serializable values

Safety

The caller must ensure each value in the array serializes to either:

• A number
• A string

pub fn not_in<IFS: IFSValueMarker>( self, values: impl Into<FixedVec<IFS, 5>>, ) -> FieldFilter

Creates a NOT IN filter accepting up to 5 values

Examples

let path = FieldPath::new("user.role")?;
let filter = path.not_in(["admin", "moderator"]);

pub unsafe fn not_in_unchecked<T: Serialize>( self, values: impl Into<FixedVec<T, 5>>, ) -> FieldFilter

Creates a NOT IN filter from any array of up to 5 serializable values

Safety

The caller must ensure values in the array serializes to either:

• Numbers
• Strings

pub fn between<IFS: IFSValueMarker>(self, start: IFS, end: IFS) -> FieldFilter

Creates a BETWEEN filter that matches values in a range

pub unsafe fn between_unchecked<T: Serialize>( self, start: T, end: T, ) -> FieldFilter

Creates a BETWEEN filter from any two serializable values

Safety

The caller must ensure both values serialize to either:

• Numbers
• Strings

pub fn contains_any<IFS: IFSValueMarker>( self, values: impl Into<FixedVec<IFS, 20>>, ) -> FieldFilter

Creates a contains any filter accepting up to 20 values

Examples

let path = FieldPath::new("user.permissions")?;
let filter = path.contains_any(["read", "write", "delete"]);

pub unsafe fn contains_any_unchecked<T: Serialize>( self, values: impl Into<FixedVec<T, 20>>, ) -> FieldFilter

Creates a contains any filter from any array of up to 20 serializable values

Safety

The caller must ensure values in the array serializes to either:

• Numbers
• Strings

Trait Implementations

impl Clone for FieldPath

fn clone(&self) -> FieldPath

Returns a copy 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 PartialEq for FieldPath

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldPath