Struct OrderByField 

pub struct OrderByField {
    pub column: Cow<'static, str>,
    pub order: SortOrder,
    pub nulls: Option<NullsOrder>,
}

Order by specification for a single field.

Fields

column: Cow<'static, str>

The column name to order by.

order: SortOrder

The sort order.

nulls: Option<NullsOrder>

Null handling (optional).

Implementations

impl OrderByField

pub fn new(column: impl Into<Cow<'static, str>>, order: SortOrder) -> Self

Create a new order by field.

pub const fn new_static(column: &'static str, order: SortOrder) -> Self

Create a new order by field with a static column name (zero allocation).

pub fn nulls(self, nulls: NullsOrder) -> Self

Set null handling.

pub fn asc(column: impl Into<Cow<'static, str>>) -> Self

Create an ascending order.

pub fn desc(column: impl Into<Cow<'static, str>>) -> Self

Create a descending order.

pub const fn asc_static(column: &'static str) -> Self

Create an ascending order with a static column name (zero allocation).

pub const fn desc_static(column: &'static str) -> Self

Create a descending order with a static column name (zero allocation).

pub fn to_sql(&self) -> String

Generate the SQL for this order by field.

Optimized to write directly to a pre-sized buffer.

pub fn write_sql(&self, buffer: &mut String)

Write the SQL directly to a buffer (zero allocation).

Examples

use prax_query::types::OrderByField;

let field = OrderByField::desc("created_at");
let mut buffer = String::with_capacity(64);
buffer.push_str("ORDER BY ");
field.write_sql(&mut buffer);
assert_eq!(buffer, "ORDER BY created_at DESC");

pub fn estimated_len(&self) -> usize

Get the estimated SQL length for capacity planning.

Trait Implementations

impl Clone for OrderByField

fn clone(&self) -> OrderByField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderByField

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

Formats the value using the given formatter.

impl From<OrderByField> for OrderBy

fn from(field: OrderByField) -> Self

Converts to this type from the input type.

impl PartialEq for OrderByField

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

impl StructuralPartialEq for OrderByField