Struct FieldRef 

pub struct FieldRef<M, T> { /* private fields */ }

Type-safe field reference for database operations

FieldRef<M, T> provides compile-time type safety for field references, where M is the model type and T is the field type.

This type replaces Python-style __ (double underscore) field lookup notation with Rust-idiomatic typed field accessors.

Type Parameters

• M: Model type (e.g., User, Post)
• T: Field type (e.g., i64, String)

Examples

use reinhardt_db::orm::expressions::FieldRef;
use reinhardt_core::macros::model;
use serde::{Serialize, Deserialize};

#[model(app_label = "users", table_name = "users")]
#[derive(Serialize, Deserialize)]
struct User {
    #[field(primary_key = true)]
    id: i64,
    #[field(max_length = 255)]
    name: String,
    #[field(max_length = 255)]
    email: String,
}

// The #[model] attribute macro automatically generates:
// impl User {
//     pub const fn field_id() -> FieldRef<User, i64> {
//         FieldRef::new("id")
//     }
//     pub const fn field_name() -> FieldRef<User, String> {
//         FieldRef::new("name")
//     }
//     pub const fn field_email() -> FieldRef<User, String> {
//         FieldRef::new("email")
//     }
// }

// Basic usage:
let id_ref = User::field_id();
assert_eq!(id_ref.name(), "id");
assert_eq!(id_ref.to_sql(), "id");

// Convert to F expression for use in queries:
use reinhardt_db::orm::expressions::F;
let f: F = User::field_name().into();
assert_eq!(f.to_sql(), "name");

Implementations

impl<M, T> FieldRef<M, T>

pub const fn new(name: &'static str) -> FieldRef<M, T>

Available on native and crate feature database only.

Create a new field reference with compile-time type safety

This constructor is typically used by the #[derive(Model)] macro to generate field accessor methods.

Arguments

• name: Field name as a static string

Examples

use reinhardt_db::orm::expressions::FieldRef;

const USER_ID: FieldRef<User, i64> = FieldRef::new("id");

pub const fn name(&self) -> &'static str

Available on native and crate feature database only.

Get the field name

Examples

let id_ref = User::field_id();
assert_eq!(id_ref.name(), "id");

pub fn assign<V>(&self, value: V) -> FieldAssignment

where V: Into<UpdateValue>,

Available on native and crate feature database only.

Create a partial-update assignment for this field.

Examples

User::objects()
    .filter(User::field_id().eq(1))
    .update_fields([User::field_last_login().assign(chrono::Utc::now())])
    .await?;

pub fn to_sql(&self) -> String

Available on native and crate feature database only.

Convert to SQL representation

Examples

let id_ref = User::field_id();
assert_eq!(id_ref.to_sql(), "\"id\"");

pub fn eq<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create an equality filter for this field

Examples

let filter = User::field_id().eq(42);
// Results in: WHERE id = 42

pub fn exact<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create an exact equality filter using Django lookup naming.

pub fn iexact<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a case-insensitive exact match filter.

pub fn ne<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a not-equal filter for this field

Examples

let filter = User::field_status().ne("inactive");
// Results in: WHERE status != 'inactive'

pub fn gt<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a greater-than filter for this field

Examples

let filter = User::field_age().gt(18);
// Results in: WHERE age > 18

pub fn gte<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a greater-than-or-equal filter for this field

Examples

let filter = User::field_age().gte(18);
// Results in: WHERE age >= 18

pub fn lt<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a less-than filter for this field

Examples

let filter = User::field_age().lt(65);
// Results in: WHERE age < 65

pub fn lte<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a less-than-or-equal filter for this field

Examples

let filter = User::field_age().lte(65);
// Results in: WHERE age <= 65

pub fn is_in<I, V>(&self, values: I) -> Filter

where I: IntoIterator<Item = V>, V: Into<FilterValue>,

Available on native and crate feature database only.

Create an IN filter. Named is_in because in is a Rust keyword.

pub fn not_in<I, V>(&self, values: I) -> Filter

where I: IntoIterator<Item = V>, V: Into<FilterValue>,

Available on native and crate feature database only.

Create a NOT IN filter.

pub fn contains<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a LIKE %value% containment filter.

pub fn icontains<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a case-insensitive containment filter.

pub fn starts_with<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a LIKE value% prefix filter.

pub fn istarts_with<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a case-insensitive prefix filter.

pub fn ends_with<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a LIKE %value suffix filter.

pub fn iends_with<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a case-insensitive suffix filter.

pub fn is_null(&self) -> Filter

Available on native and crate feature database only.

Create an IS NULL filter.

pub fn is_not_null(&self) -> Filter

Available on native and crate feature database only.

Create an IS NOT NULL filter.

pub fn regex<V>(&self, pattern: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a regular expression filter.

pub fn iregex<V>(&self, pattern: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a case-insensitive regular expression filter.

pub fn range<V>(&self, start: V, end: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a BETWEEN filter.

pub fn array_contains<I, V>(&self, values: I) -> Filter

where I: IntoIterator<Item = V>, V: ToString,

Available on native and crate feature database only.

Create a PostgreSQL array containment filter (@>).

pub fn array_contained_by<I, V>(&self, values: I) -> Filter

where I: IntoIterator<Item = V>, V: ToString,

Available on native and crate feature database only.

Create a PostgreSQL array contained-by filter (<@).

pub fn array_overlap<I, V>(&self, values: I) -> Filter

where I: IntoIterator<Item = V>, V: ToString,

Available on native and crate feature database only.

Create a PostgreSQL array overlap filter (&&).

pub fn jsonb_contains(&self, json: &str) -> Filter

Available on native and crate feature database only.

Create a PostgreSQL JSONB containment filter (@>).

pub fn jsonb_contained_by(&self, json: &str) -> Filter

Available on native and crate feature database only.

Create a PostgreSQL JSONB contained-by filter (<@).

pub fn jsonb_has_key(&self, key: &str) -> Filter

Available on native and crate feature database only.

Create a PostgreSQL JSONB key-exists filter (?).

pub fn jsonb_has_any_keys<I, V>(&self, keys: I) -> Filter

where I: IntoIterator<Item = V>, V: ToString,

Available on native and crate feature database only.

Create a PostgreSQL JSONB any-key-exists filter (?|).

pub fn jsonb_has_keys<I, V>(&self, keys: I) -> Filter

where I: IntoIterator<Item = V>, V: ToString,

Available on native and crate feature database only.

Create a PostgreSQL JSONB all-keys-exist filter (?&).

pub fn jsonb_path_exists(&self, path: &str) -> Filter

Available on native and crate feature database only.

Create a PostgreSQL JSONPath existence filter (@?).

pub fn range_contains<V>(&self, value: V) -> Filter

where V: Into<FilterValue>,

Available on native and crate feature database only.

Create a PostgreSQL range field containment filter (@>).

pub fn range_contained_by(&self, range: &str) -> Filter

Available on native and crate feature database only.

Create a PostgreSQL range field contained-by filter (<@).

pub fn range_overlaps(&self, range: &str) -> Filter

Available on native and crate feature database only.

Create a PostgreSQL range field overlap filter (&&).

pub fn date(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a date/datetime field to its date component.

pub fn time(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a datetime/time field to its time component.

pub fn year(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a date/datetime field to its year component.

pub fn iso_year(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a date/datetime field to its ISO year component.

pub fn month(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a date/datetime field to its month component.

pub fn day(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a date/datetime field to its day component.

pub fn week(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a date/datetime field to its week component.

pub fn week_day(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform to Django-compatible weekday where Sunday is 1.

pub fn iso_week_day(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform to ISO weekday where Monday is 1.

pub fn quarter(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a date/datetime field to its quarter component.

pub fn hour(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a datetime/time field to its hour component.

pub fn minute(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a datetime/time field to its minute component.

pub fn second(&self) -> TransformedFieldRef<M>

Available on native and crate feature database only.

Transform a datetime/time field to its second component.

pub fn eq_field<T2>(&self, other: FieldRef<M, T2>) -> Filter

Available on native and crate feature database only.

Create an equality filter comparing this field to another field

Examples

let filter = Order::field_discount_price().eq_field(Order::field_total_price());
// Results in: WHERE discount_price = total_price

pub fn ne_field<T2>(&self, other: FieldRef<M, T2>) -> Filter

Available on native and crate feature database only.

Create a not-equal filter comparing this field to another field

Examples

let filter = Order::field_discount_price().ne_field(Order::field_total_price());
// Results in: WHERE discount_price != total_price

pub fn gt_field<T2>(&self, other: FieldRef<M, T2>) -> Filter

Available on native and crate feature database only.

Create a greater-than filter comparing this field to another field

Examples

let filter = Order::field_total_price().gt_field(Order::field_discount_price());
// Results in: WHERE total_price > discount_price

pub fn gte_field<T2>(&self, other: FieldRef<M, T2>) -> Filter

Available on native and crate feature database only.

Create a greater-than-or-equal filter comparing this field to another field

Examples

let filter = Order::field_total_price().gte_field(Order::field_discount_price());
// Results in: WHERE total_price >= discount_price

pub fn lt_field<T2>(&self, other: FieldRef<M, T2>) -> Filter

Available on native and crate feature database only.

Create a less-than filter comparing this field to another field

Examples

let filter = Order::field_discount_price().lt_field(Order::field_total_price());
// Results in: WHERE discount_price < total_price

pub fn lte_field<T2>(&self, other: FieldRef<M, T2>) -> Filter

Available on native and crate feature database only.

Create a less-than-or-equal filter comparing this field to another field

Examples

let filter = Order::field_discount_price().lte_field(Order::field_total_price());
// Results in: WHERE discount_price <= total_price

Trait Implementations

impl<M, T> Clone for FieldRef<M, T>

where M: Clone, T: Clone,

fn clone(&self) -> FieldRef<M, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M, T> Copy for FieldRef<M, T>

where M: Copy, T: Copy,

impl<M, T> Debug for FieldRef<M, T>

where M: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<M, T> Display for FieldRef<M, T>

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

Formats the value using the given formatter.

impl<M, T> From<FieldRef<M, T>> for String

fn from(field_ref: FieldRef<M, T>) -> String

Converts to this type from the input type.

impl<M, T> From<FieldRef<M, T>> for F

fn from(field_ref: FieldRef<M, T>) -> F

Converts to this type from the input type.