Enum BuildError 

#[non_exhaustive]
pub enum BuildError {
    LockRequiresSelect,
    DistinctOnRequiresPostgres,
    EmptyInsert,
    EmptyUpdate,
    OffsetWithoutLimit,
    LockWithUnion,
    InvalidHavingOperator(String),
}

Invalid query construction, detected when compiling a QueryBuilder.

Returned by try_to_sql / try_compile (and the sqlx handoff twins try_to_sqlx_query / try_to_sqlx_query_as). The panicking to_sql path panics with this type’s Display message.

All variants describe caller mistakes (a query that cannot be rendered as valid SQL), never internal compiler state — a web app can therefore map errors caused by end-user input (e.g. an operator or pagination parameter taken from a request) to HTTP 4XX and the rest to 5XX.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

LockRequiresSelect

for_update()/for_share() on a non-SELECT query.

DistinctOnRequiresPostgres

distinct_on(...) compiled for a dialect without DISTINCT ON.

EmptyInsert

insert() with no columns.

EmptyUpdate

update() with no columns.

OffsetWithoutLimit

offset(...) without limit(...).

LockWithUnion

for_update()/for_share() combined with UNION.

InvalidHavingOperator(String)

having() received an operator outside the fixed allowlist. Carries the rejected operator as passed by the caller.

Trait Implementations

impl Clone for BuildError

fn clone(&self) -> BuildError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildError

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

Formats the value using the given formatter.

impl Display for BuildError

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

Formats the value using the given formatter.

impl Eq for BuildError

impl Error for BuildError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<BuildError> for Error

fn from(e: BuildError) -> Self

Converts to this type from the input type.

impl PartialEq for BuildError

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