Struct FunctionParameter 

pub struct FunctionParameter<const NAMED: bool> {
    pub name: &'static str,
}

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Helper type to represent a parameter of a SQL function. Used to allow passing the parameter by name or by position, depending on the value of NAMED and the SqlDialect::SqlFunctionParameterNotation specialization type.

Fields

name: &'static str

The name of the function parameter.

Trait Implementations

impl<const NAMED: bool> Clone for FunctionParameter<NAMED>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const NAMED: bool> Copy for FunctionParameter<NAMED>

impl<const NAMED: bool> Debug for FunctionParameter<NAMED>

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

Formats the value using the given formatter.

impl<DB> QueryFragment<DB, PositionalNotationOnly> for FunctionParameter<false>

where DB: Backend + SqlDialect<SqlFunctionParameterNotation = PositionalNotationOnly>,

fn walk_ast<'b>(&'b self, _out: AstPass<'_, 'b, DB>) -> QueryResult<()>

Walk over this QueryFragment for all passes.

fn to_sql(&self, out: &mut DB::QueryBuilder, backend: &DB) -> QueryResult<()>

Converts this QueryFragment to its SQL representation.

fn collect_binds<'b>( &'b self, out: &mut DB::BindCollector<'b>, metadata_lookup: &mut DB::MetadataLookup, backend: &'b DB, ) -> QueryResult<()>

Serializes all bind parameters in this query.

fn is_safe_to_cache_prepared(&self, backend: &DB) -> QueryResult<bool>

Is this query safe to store in the prepared statement cache?

fn is_noop(&self, backend: &DB) -> QueryResult<bool>

Does walking this AST have any effect?

fn count_binds(&self, backend: &DB) -> QueryResult<usize>

Count the number of binds in a given prepared statement

impl<DB> QueryFragment<DB, PositionalOrNamedNotation> for FunctionParameter<false>

where DB: Backend + SqlDialect<SqlFunctionParameterNotation = PositionalOrNamedNotation>,

fn walk_ast<'b>(&'b self, _out: AstPass<'_, 'b, DB>) -> QueryResult<()>

Walk over this QueryFragment for all passes.

fn to_sql(&self, out: &mut DB::QueryBuilder, backend: &DB) -> QueryResult<()>

Converts this QueryFragment to its SQL representation.

fn collect_binds<'b>( &'b self, out: &mut DB::BindCollector<'b>, metadata_lookup: &mut DB::MetadataLookup, backend: &'b DB, ) -> QueryResult<()>

Serializes all bind parameters in this query.

fn is_safe_to_cache_prepared(&self, backend: &DB) -> QueryResult<bool>

Is this query safe to store in the prepared statement cache?

fn is_noop(&self, backend: &DB) -> QueryResult<bool>

Does walking this AST have any effect?

fn count_binds(&self, backend: &DB) -> QueryResult<usize>

Count the number of binds in a given prepared statement

impl<DB> QueryFragment<DB, PositionalOrNamedNotation> for FunctionParameter<true>

where DB: Backend + SqlDialect<SqlFunctionParameterNotation = PositionalOrNamedNotation>,

fn walk_ast<'b>(&'b self, out: AstPass<'_, 'b, DB>) -> QueryResult<()>

Walk over this QueryFragment for all passes.

fn to_sql(&self, out: &mut DB::QueryBuilder, backend: &DB) -> QueryResult<()>

Converts this QueryFragment to its SQL representation.

fn collect_binds<'b>( &'b self, out: &mut DB::BindCollector<'b>, metadata_lookup: &mut DB::MetadataLookup, backend: &'b DB, ) -> QueryResult<()>

Serializes all bind parameters in this query.

fn is_safe_to_cache_prepared(&self, backend: &DB) -> QueryResult<bool>

Is this query safe to store in the prepared statement cache?

fn is_noop(&self, backend: &DB) -> QueryResult<bool>

Does walking this AST have any effect?

fn count_binds(&self, backend: &DB) -> QueryResult<usize>

Count the number of binds in a given prepared statement

impl<const NAMED: bool> QueryId for FunctionParameter<NAMED>

const HAS_STATIC_QUERY_ID: bool = true

Can the SQL generated by Self be uniquely identified by its type?

type QueryId = FunctionParameter<NAMED>

A type which uniquely represents Self in a SQL query.

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.