Enum Returning 

pub enum Returning {
    Model {
        include: Vec<Path>,
    },
    Changed,
    Project(Expr),
    Expr(Expr),
}

Specifies what data a statement returns.

Used both as the projection in SELECT queries and as the RETURNING clause in INSERT, UPDATE, and DELETE statements.

Examples

use toasty_core::stmt::Returning;

let ret = Returning::Model { include: vec![] };
assert!(ret.is_model());

Variants

Model

Return the full model with the specified association includes.

Fields

include: Vec<Path>

Paths to associations that should be eagerly loaded.

Changed

Return whether the operation changed any rows.

Project(Expr)

Return the result of evaluating an expression against the source rows.

Expr(Expr)

Return a fixed expression, independent of the statement source.

Implementations

impl Returning

pub fn from_project_iter<T>(items: impl IntoIterator<Item = T>) -> Returning

where T: Into<Expr>,

Creates a Returning::Project from an iterator of expressions, combining them into a record expression.

pub fn is_model(&self) -> bool

Returns true if this is the Model variant.

pub fn model_includes(&self) -> &[Path]

Returns the association include paths for a Model variant, or an empty slice for other variants.

pub fn model_includes_mut_unwrap(&mut self) -> &mut Vec<Path>

Returns a mutable reference to the Model variant’s include paths.

Panics

Panics if this is not the Model variant.

pub fn is_changed(&self) -> bool

Returns true if this is the Changed variant.

pub fn is_project(&self) -> bool

Returns true if this is the Project variant.

pub fn as_project(&self) -> Option<&Expr>

Returns a reference to the inner expression if this is the Project variant.

pub fn as_project_unwrap(&self) -> &Expr

Returns a reference to the inner expression.

Panics

Panics if this is not the Project variant.

pub fn as_project_mut(&mut self) -> Option<&mut Expr>

Returns a mutable reference to the inner expression if this is the Project variant.

pub fn as_project_mut_unwrap(&mut self) -> &mut Expr

Returns a mutable reference to the inner expression.

Panics

Panics if this is not the Project variant.

pub fn set_project(&mut self, expr: impl Into<Expr>)

Replaces this returning clause with Returning::Project containing the given expression.

pub fn is_expr(&self) -> bool

Returns true if this is the Expr variant.

pub fn take(&mut self) -> Returning

Takes this returning clause, replacing it with Returning::Project(null), and returns the original value.

Trait Implementations

impl Clone for Returning

fn clone(&self) -> Returning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Returning

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

Formats the value using the given formatter.

impl Node for Returning

fn visit<V>(&self, visit: V)

where V: Visit, Returning: Sized,

Traverses this node with an immutable visitor.

fn visit_mut<V>(&mut self, visit: V)

where V: VisitMut,

Traverses this node with a mutable visitor.

impl PartialEq for Returning

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