Skip to main content

Column

Struct Column 

Source
pub struct Column<T> { /* private fields */ }
Expand description

Typed column reference.

Column is a zero-cost abstraction that carries type information at compile time without runtime overhead. It is Copy and uses only static string references.

§Examples

use nautilus_core::{Column, Expr, Value};

let id_col: Column<i64> = Column::new("users", "id");
let expr = id_col.eq(42);

Implementations§

Source§

impl<T> Column<T>

Source

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

Creates a new typed column reference.

This is a const fn, so columns can be defined as constants.

§Examples
use nautilus_core::Column;

const USER_ID: Column<i64> = Column::new("users", "id");
const USER_EMAIL: Column<String> = Column::new("users", "email");
Source

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

Returns the table name.

Source

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

Returns the column name.

Source

pub fn marker(&self) -> ColumnMarker

Returns a column marker for this column.

Static generated columns borrow their metadata without allocating.

Source

pub fn alias(&self) -> String

Returns the join-safe alias for this column.

The alias uses the format "table__column" which is safe to use in queries with joins, preventing column name conflicts.

Matches the naming of ColumnMarker::alias.

§Examples
use nautilus_core::Column;

let id: Column<i64> = Column::new("users", "id");
assert_eq!(id.alias(), "users__id");
Source

pub fn eq<V>(self, value: V) -> Expr
where V: Into<Value>,

Creates an equality comparison (=).

§Examples
use nautilus_core::{Column, Expr, Value};

let id: Column<i64> = Column::new("users", "id");
let expr = id.eq(42);
Source

pub fn eq_column<U>(self, other: Column<U>) -> Expr

Creates a column-to-column equality expression.

This is useful for JOIN ON conditions where both sides are columns.

§Examples
use nautilus_core::{Column, Expr};

let user_id: Column<i64> = Column::new("users", "id");
let post_user_id: Column<i64> = Column::new("posts", "user_id");
let on = user_id.eq_column(post_user_id);
Source

pub fn desc(self) -> OrderBy

Creates a descending ORDER BY clause.

§Examples
use nautilus_core::{Column, OrderBy, OrderDir};

let email: Column<String> = Column::new("users", "email");
let order = email.desc();
assert_eq!(order.direction, OrderDir::Desc);
Source

pub fn asc(self) -> OrderBy

Creates an ascending ORDER BY clause.

§Examples
use nautilus_core::{Column, OrderBy, OrderDir};

let email: Column<String> = Column::new("users", "email");
let order = email.asc();
assert_eq!(order.direction, OrderDir::Asc);
Source§

impl Column<String>

Source

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

Creates a LIKE expression for suffix matching.

Generates a SQL LIKE pattern of the form %suffix.

§Examples
use nautilus_core::{Column, Expr, Value};

let email: Column<String> = Column::new("users", "email");
let expr = email.ends_with("example.com");
Source

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

Creates a LIKE expression for prefix matching.

Generates a SQL LIKE pattern of the form prefix%.

§Examples
use nautilus_core::{Column, Expr, Value};

let email: Column<String> = Column::new("users", "email");
let expr = email.starts_with("admin");
Source

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

Creates a LIKE expression for substring matching.

Generates a SQL LIKE pattern of the form %substring%.

§Examples
use nautilus_core::{Column, Expr, Value};

let email: Column<String> = Column::new("users", "email");
let expr = email.contains("example");
Source§

impl<T> Column<Vec<T>>
where T: Into<Value> + Clone,

Source

pub fn contains_elem(self, elem: T) -> Expr

Creates an array contains expression (@> in PostgreSQL).

Returns rows where the column array contains the given element.

§Examples
use nautilus_core::{Column, Expr, Value};

let tags: Column<Vec<String>> = Column::new("posts", "tags");
let expr = tags.contains_elem("rust".to_string());
Source

pub fn contains_all(self, elements: Vec<T>) -> Expr

Creates an array contains expression for multiple elements (@> in PostgreSQL).

Returns rows where the column array contains all the given elements.

§Examples
use nautilus_core::{Column, Expr, Value};

let tags: Column<Vec<String>> = Column::new("posts", "tags");
let expr = tags.contains_all(vec!["rust".to_string(), "programming".to_string()]);
Source

pub fn contained_by(self, container: Vec<T>) -> Expr

Creates an array contained by expression (<@ in PostgreSQL).

Returns rows where the column array is contained by the given array.

§Examples
use nautilus_core::{Column, Expr, Value};

let tags: Column<Vec<String>> = Column::new("posts", "tags");
let expr = tags.contained_by(vec!["rust".to_string(), "go".to_string()]);
Source

pub fn overlaps(self, other: Vec<T>) -> Expr

Creates an array overlaps expression (&& in PostgreSQL).

Returns rows where the column array has any elements in common with the given array.

§Examples
use nautilus_core::{Column, Expr, Value};

let tags: Column<Vec<String>> = Column::new("posts", "tags");
let expr = tags.overlaps(vec!["rust".to_string(), "go".to_string()]);

Trait Implementations§

Source§

impl<T> Clone for Column<T>
where T: Clone,

Source§

fn clone(&self) -> Column<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Copy for Column<T>
where T: Copy,

Source§

impl<T> Debug for Column<T>
where T: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Eq for Column<T>
where T: Eq,

Source§

impl<T> PartialEq for Column<T>
where T: PartialEq,

Source§

fn eq(&self, other: &Column<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> StructuralPartialEq for Column<T>

Auto Trait Implementations§

§

impl<T> Freeze for Column<T>

§

impl<T> RefUnwindSafe for Column<T>
where T: RefUnwindSafe,

§

impl<T> Send for Column<T>
where T: Send,

§

impl<T> Sync for Column<T>
where T: Sync,

§

impl<T> Unpin for Column<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Column<T>

§

impl<T> UnwindSafe for Column<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more