Skip to main content

Param

Enum Param 

Source
#[non_exhaustive]
pub enum Param {
Show 13 variants Now, Group, Limit, Id, Ids, RetryAfter, Destination, Delay, Lease, LeaseNow, Held, Key, Column(usize),
}
Expand description

A value a statement binds, named by its meaning; the broker supplies it when the statement runs.

§Examples

use ruststream_sqlx_dialect::{Dialect, Param, Statement, StatementError, TableSpec};

/// SQL Server, a database without a built-in dialect.
#[derive(Debug)]
pub struct Mssql;

impl Dialect for Mssql {
    fn name(&self) -> &'static str {
        "mssql"
    }

    // A delayed retry of a leased email names the row and the lease its delivery holds; the
    // broker binds the delay's end, the id and the lease, in this order.
    fn retry_after(&self, _spec: &TableSpec<'_>) -> Result<Statement, StatementError> {
        Ok(Statement::new(
            "UPDATE [email_jobs] SET [retry_after] = @p1, [locked_until] = NULL \
             WHERE [job_id] = @p2 AND [locked_until] = @p3",
            [Param::RetryAfter, Param::Id, Param::Held],
        ))
    }
}

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Now

The current time, in the type of the column it meets.

§

Group

The group the subscription reads.

§

Limit

The most rows one claim takes.

§

Id

The id of the row being settled.

§

Ids

The ids a fetch assembles, as one list.

§

RetryAfter

The time before which a row is not claimed again.

§

Destination

Where a dead-lettered row goes: the name of its new group.

§

Delay

The delay of a retry in microseconds, for a statement that adds it to the database’s own time.

§

Lease

The expiry a claim, a stamp or an extension writes into the lease column: the row stays with its delivery until then.

§

LeaseNow

The current time, in the type of the lease column: a row whose lease ended by then is claimable.

§

Held

The expiry the delivery’s claim or its last extension wrote: the ownership token that settlement and extension match.

§

Key

The lock key of the row, as text: what the advisory claim selected as __lock, which the lock and the unlock name.

§

Column(usize)

The value of the column at this position of TableSpec::columns, for an insert.

Trait Implementations§

Source§

impl Clone for Param

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Param

Source§

impl Debug for Param

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Param

Source§

impl Hash for Param

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Param

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Param

Auto Trait Implementations§

§

impl Freeze for Param

§

impl RefUnwindSafe for Param

§

impl Send for Param

§

impl Sync for Param

§

impl Unpin for Param

§

impl UnsafeUnpin for Param

§

impl UnwindSafe for Param

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.