Struct UtilityOption

pub struct UtilityOption {
    pub name: Ident,
    pub arg: Option<Expr>,
}

Represents a single PostgreSQL utility option.

A utility option is a key-value pair where the key is an identifier (IDENT) and the value can be one of the following:

• A number with an optional sign (+ or -). Example: +10, -10.2, 3
• A non-keyword string. Example: option1, 'option2', "option3"
• keyword: TRUE, FALSE, ON (off is also accept).
• Empty. Example: ANALYZE (identifier only)

Utility options are used in various PostgreSQL DDL statements, including statements such as CLUSTER, EXPLAIN, VACUUM, and REINDEX. These statements format options as ( option [, ...] ).

CLUSTER EXPLAIN VACUUM REINDEX

For example, the EXPLAIN AND VACUUM statements with options might look like this:

EXPLAIN (ANALYZE, VERBOSE TRUE, FORMAT TEXT) SELECT * FROM my_table;

VACCUM (VERBOSE, ANALYZE ON, PARALLEL 10) my_table;

Fields

name: Ident

arg: Option<Expr>

Trait Implementations

impl Clone for UtilityOption

fn clone(&self) -> UtilityOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UtilityOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UtilityOption

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UtilityOption

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

Formats the value using the given formatter.

impl Hash for UtilityOption

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for UtilityOption

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UtilityOption

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for UtilityOption

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Visit for UtilityOption

fn visit<V: Visitor>(&self, visitor: &mut V) -> ControlFlow<V::Break>

impl VisitMut for UtilityOption

fn visit<V: VisitorMut>(&mut self, visitor: &mut V) -> ControlFlow<V::Break>

impl Eq for UtilityOption

impl StructuralPartialEq for UtilityOption