Skip to main content

Modifier

Enum Modifier 

Source
pub enum Modifier {
Show 13 variants Distinct, DistinctRow, LowPriority, HighPriority, Delayed, Quick, Ignore, StraightJoin, SmallResult, BigResult, BufferResult, NoCache, CalcFoundRows,
}
Expand description

One of MySQL’s statement modifiers — the keywords between a statement’s first word and its real content.

MySQL spreads these across four productions:

SELECT [ALL | DISTINCT | DISTINCTROW] [HIGH_PRIORITY] [STRAIGHT_JOIN]
       [SQL_SMALL_RESULT] [SQL_BIG_RESULT] [SQL_BUFFER_RESULT]
       [SQL_NO_CACHE] [SQL_CALC_FOUND_ROWS] …
INSERT [LOW_PRIORITY | DELAYED | HIGH_PRIORITY] [IGNORE] …
UPDATE [LOW_PRIORITY] [IGNORE] …
DELETE [LOW_PRIORITY] [QUICK] [IGNORE] …

The order below is the grammar’s order, and Modifiers keeps its list sorted by it. That is the whole reason this is an enum rather than bob’s []string: bob appends the keywords in whatever order the mods were written, so im.Ignore(), im.HighPriority() produces INSERT IGNORE HIGH_PRIORITY, which MySQL rejects. Here mod order cannot affect the output.

Which modifiers a statement permits is decided by which of them its mod module re-exports, exactly as with the clause traits.

ALL is the default in SELECT and adds nothing, so it is not representable — the absence of Distinct is what it means.

Variants§

§

Distinct

DISTINCT — drop duplicate result rows.

§

DistinctRow

DISTINCTROW, MySQL’s synonym for DISTINCT.

§

LowPriority

LOW_PRIORITY — wait for readers before writing.

§

HighPriority

HIGH_PRIORITY — jump the queue ahead of pending writes.

§

Delayed

DELAYED — accepted and deprecated; MySQL treats it as INSERT and warns.

§

Quick

QUICK — do not merge index leaves while deleting.

§

Ignore

IGNORE — turn errors that would abort the statement into warnings.

§

StraightJoin

STRAIGHT_JOIN — join tables in the order they are written.

§

SmallResult

SQL_SMALL_RESULT — the result set is small; use an in-memory temp table.

§

BigResult

SQL_BIG_RESULT — the result set is large; sort rather than use an index.

§

BufferResult

SQL_BUFFER_RESULT — force the result into a temporary table.

§

NoCache

SQL_NO_CACHE — do not read or write the query cache.

§

CalcFoundRows

SQL_CALC_FOUND_ROWS — count the rows a LIMIT discarded.

Implementations§

Source§

impl Modifier

Source

pub fn as_str(self) -> &'static str

The keyword, as written.

Trait Implementations§

Source§

impl Clone for Modifier

Source§

fn clone(&self) -> Modifier

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 Copy for Modifier

Source§

impl Debug for Modifier

Source§

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

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

impl Eq for Modifier

Source§

impl Hash for Modifier

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Modifier

Source§

fn cmp(&self, other: &Modifier) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Modifier

Source§

fn eq(&self, other: &Modifier) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Modifier

Source§

fn partial_cmp(&self, other: &Modifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for Modifier

Auto Trait Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.