Enum mz_sql::session::vars::VarError

pub enum VarError {
    ConstrainedParameter {
        name: &'static str,
        invalid_values: Vec<String>,
        valid_values: Option<Vec<&'static str>>,
    },
    FixedValueParameter {
        name: &'static str,
        value: String,
    },
    InvalidParameterType {
        name: &'static str,
        required_type: Cow<'static, str>,
    },
    InvalidParameterValue {
        name: &'static str,
        invalid_values: Vec<String>,
        reason: String,
    },
    ReadOnlyParameter(&'static str),
    UnknownParameter(String),
    RequiresUnsafeMode(&'static str),
    RequiresFeatureFlag {
        feature: String,
        detail: Option<String>,
        name_hint: Option<&'static UncasedStr>,
    },
}

Errors that can occur when working with Vars

Variants

ConstrainedParameter

The specified session parameter is constrained to a finite set of values.

Fields

name: &'static str

Name of the parameter.

invalid_values: Vec<String>

valid_values: Option<Vec<&'static str>>

FixedValueParameter

The specified parameter is fixed to a single specific value.

We allow setting the parameter to its fixed value for compatibility with PostgreSQL-based tools.

Fields

name: &'static str

Name of the parameter.

value: String

The value the parameter is fixed at.

InvalidParameterType

The value for the specified parameter does not have the right type.

Fields

name: &'static str

Name of the parameter.

required_type: Cow<'static, str>

Required type of the parameter.

InvalidParameterValue

The value of the specified parameter is incorrect.

Fields

name: &'static str

Name of the parameter.

invalid_values: Vec<String>

Invalid values.

reason: String

Reason the values are invalid.

ReadOnlyParameter(&'static str)

The specified session parameter is read only.

UnknownParameter(String)

The named parameter is unknown to the system.

RequiresUnsafeMode(&'static str)

The specified session parameter is read only unless in unsafe mode.

RequiresFeatureFlag

Fields

feature: String

detail: Option<String>

name_hint: Option<&'static UncasedStr>

If we’re running in unsafe mode and hit this error, we should surface the flag name that needs to be set to make the feature work.

Implementations

impl VarError

pub fn detail(&self) -> Option<String>

pub fn hint(&self) -> Option<String>

Trait Implementations

impl Clone for VarError

fn clone(&self) -> VarError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarError

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

Formats the value using the given formatter.

impl Display for VarError

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

Formats the value using the given formatter.

impl Error for VarError

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<VarError> for PlanError

fn from(e: VarError) -> Self

Converts to this type from the input type.

impl PartialEq for VarError

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

impl StructuralPartialEq for VarError