Enum Field 

#[non_exhaustive]
pub enum Field {
    JsonbField(String),
    DirectColumn(String),
    JsonbPath(Vec<String>),
}

Represents a field reference in a WHERE clause or ORDER BY

Supports both JSONB payload fields and direct database columns, with automatic type casting and proper SQL generation.

Examples

use fraiseql_wire::operators::Field;

// JSONB field: (data->>'name')
let _ = Field::JsonbField("name".to_string());

// Direct column: created_at
let _ = Field::DirectColumn("created_at".to_string());

// Nested JSONB: (data->'user'->>'name')
let _ = Field::JsonbPath(vec!["user".to_string(), "name".to_string()]);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

JsonbField(String)

A field extracted from the JSONB data column with text extraction (->>)

The value is extracted as text and wrapped in parentheses.

Generated SQL: (data->>'field_name')

DirectColumn(String)

A direct database column (not from JSONB)

Uses the native type stored in the database.

Generated SQL: column_name

JsonbPath(Vec<String>)

A nested path within the JSONB data column

The path is traversed left-to-right, with intermediate steps using -> (JSON navigation) and the final step using ->> (text extraction).

All extracted values are text and wrapped in parentheses.

Generated SQL: (data->'path[0]'->...->>'path[n]')

Implementations

impl Field

pub fn validate(&self) -> Result<(), String>

Validate field name to prevent SQL injection

Allows: alphanumeric, underscore Disallows: quotes, brackets, dashes, special characters

Errors

Returns an error string if any field name (or path segment) contains characters other than alphanumeric and underscore.

pub fn to_sql(&self) -> String

Generate SQL for this field

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Display for Field

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

Formats the value using the given formatter.

impl PartialEq for Field

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

impl StructuralPartialEq for Field