Struct Field 

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

Typed column handle for model M whose Rust type is T.

Generated as associated constants by the Model derive: impl User { pub const name: Field<User, String> = Field::new("name"); }.

Implementations

impl<M, T> Field<M, T>

pub const fn new(name: &'static str) -> Self

Create a field handle. Intended for generated code.

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

Column name.

pub fn outer_ref(self) -> Expr

Reference to this column of the enclosing query, for use inside a correlated subquery (Django OuterRef).

pub fn set(self, value: impl Operand<M, T>) -> (Ident, Expr)

column = value assignment for QuerySet::update.

pub fn set_expr(self, value: impl Into<Expr>) -> (Ident, Expr)

column = <expression> assignment, e.g. Post::likes.set_expr(Post::likes + 1).

pub fn select(self) -> SelectExpr

Project this column in values(..), named after the column.

impl<M, T> Field<M, T>

pub fn expr(self) -> Expr

Untyped expression for this handle.

pub fn asc(self) -> OrderExpr

Ascending ordering.

pub fn desc(self) -> OrderExpr

Descending ordering.

pub fn is_null(self) -> Expr

IS NULL.

pub fn is_not_null(self) -> Expr

IS NOT NULL.

pub fn is_in<L: Literal<T>>(self, values: impl IntoIterator<Item = L>) -> Expr

Membership in a list of literals.

pub fn in_subquery(self, plan: QueryPlan) -> Expr

Membership in the single column a subquery selects.

pub fn range(self, lo: impl Literal<T>, hi: impl Literal<T>) -> Expr

Inclusive range.

pub fn cast(self, ty: SqlType) -> Expr

CAST(self AS ty).

impl<M, T: TextLike> Field<M, T>

pub fn iexact(self, v: impl Into<String>) -> Expr

Case-insensitive equality.

pub fn regex(self, pattern: impl Into<String>) -> Expr

Regex match (requires Feature::Regex).

impl<M, T: DateLike> Field<M, T>

pub fn year(self) -> Expr

Year component.

pub fn month(self) -> Expr

Month component.

pub fn day(self) -> Expr

Day-of-month component.

pub fn week(self) -> Expr

ISO week number.

pub fn quarter(self) -> Expr

Quarter 1..=4.

pub fn date(self) -> Expr

The date part of a timestamp.

impl<M, T: TimeLike> Field<M, T>

pub fn hour(self) -> Expr

Hour component.

pub fn minute(self) -> Expr

Minute component.

pub fn second(self) -> Expr

Second component.

impl<M, T> Field<M, T>

pub fn eq(self, rhs: impl Operand<M, T>) -> Expr

Typed eq comparison.

pub fn ne(self, rhs: impl Operand<M, T>) -> Expr

Typed ne comparison.

pub fn lt(self, rhs: impl Operand<M, T>) -> Expr

Typed lt comparison.

pub fn le(self, rhs: impl Operand<M, T>) -> Expr

Typed le comparison.

pub fn gt(self, rhs: impl Operand<M, T>) -> Expr

Typed gt comparison.

pub fn ge(self, rhs: impl Operand<M, T>) -> Expr

Typed ge comparison.

impl<M, T: TextLike> Field<M, T>

pub fn contains(self, needle: impl Into<String>) -> Expr

Text lookup contains.

pub fn icontains(self, needle: impl Into<String>) -> Expr

Text lookup icontains.

pub fn starts_with(self, needle: impl Into<String>) -> Expr

Text lookup starts_with.

pub fn istarts_with(self, needle: impl Into<String>) -> Expr

Text lookup istarts_with.

pub fn ends_with(self, needle: impl Into<String>) -> Expr

Text lookup ends_with.

pub fn iends_with(self, needle: impl Into<String>) -> Expr

Text lookup iends_with.

impl<M, S> Field<M, S>

pub fn join<T: Model, X>(self, inner: impl Related<T, X>) -> Joined<M, X>

where S: FkSlot<T>,

Reach inner, a field (or further joined field) of the model this foreign key points at: Book::author.join(Author::name).

Trait Implementations

impl<M, T: Numeric, R: Operand<M, T>> Add<R> for Field<M, T>

type Output = Calc<M, T>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Calc<M, T>

Performs the + operation.

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

impl<M, T: Numeric, R: Operand<M, T>> Div<R> for Field<M, T>

type Output = Calc<M, T>

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Calc<M, T>

Performs the / operation.

impl<M, T> From<Field<M, T>> for Expr

fn from(f: Field<M, T>) -> Self

Converts to this type from the input type.

impl<M, T> From<Field<M, T>> for SelectExpr

fn from(f: Field<M, T>) -> Self

Converts to this type from the input type.

impl<M, T: Numeric, R: Operand<M, T>> Mul<R> for Field<M, T>

type Output = Calc<M, T>

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Calc<M, T>

Performs the * operation.

impl<M, T: Numeric> Neg for Field<M, T>

type Output = Calc<M, T>

The resulting type after applying the - operator.

fn neg(self) -> Calc<M, T>

Performs the unary - operation.

impl<M, T> Operand<M, T> for Field<M, T>

fn into_expr(self) -> Expr

Convert into an expression.

impl<T, X> Related<T, X> for Field<T, X>

fn into_parts(self) -> (Vec<RelHop>, &'static str)

Hops (relative to T) and the column at their end.

impl<M, T: Numeric, R: Operand<M, T>> Rem<R> for Field<M, T>

type Output = Calc<M, T>

The resulting type after applying the % operator.

fn rem(self, rhs: R) -> Calc<M, T>

Performs the % operation.

impl<M, T: Numeric, R: Operand<M, T>> Sub<R> for Field<M, T>

type Output = Calc<M, T>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Calc<M, T>

Performs the - operation.