Skip to main content

OneTimeExecutor

Struct OneTimeExecutor 

Source
pub struct OneTimeExecutor<'c, E>
where E: Executor<'c, Database = Db> + 'c,
{ /* private fields */ }
Expand description

A struct that owns an sqlx::Executor.

Calling one of the fetch_ fns will consume it thus garuanteeing a 1 time usage.

It is not used directly but passed via the IntoOneTimeExecutor trait.

In order to make the consumption of the executor work we have to pass the query to the executor:

async fn query(ex: impl es_entity::IntoOneTimeExecutor<'_>) -> Result<(), sqlx::Error> {
    ex.into_executor().fetch_optional(
        sqlx::query!(
            "SELECT NOW()"
        )
    ).await?;
    Ok(())
}

Implementations§

Source§

impl<'c, E> OneTimeExecutor<'c, E>
where E: Executor<'c, Database = Db> + 'c,

Source

pub fn maybe_now(&self) -> Option<DateTime<Utc>>

Source

pub async fn fetch_one<'q, F, O, A>( self, query: Map<'q, Db, F, A>, ) -> Result<O, Error>
where F: FnMut(Row) -> Result<O, Error> + Send, O: Send + Unpin, A: 'q + Send + IntoArguments<'q, Db>,

Proxy call to query.fetch_one but guarantees the inner executor will only be used once.

Source

pub async fn fetch_all<'q, F, O, A>( self, query: Map<'q, Postgres, F, A>, ) -> Result<Vec<O>, Error>
where F: FnMut(PgRow) -> Result<O, Error> + Send, O: Send + Unpin, A: 'q + Send + IntoArguments<'q, Postgres>,

Proxy call to query.fetch_all but guarantees the inner executor will only be used once.

Source

pub async fn fetch_optional<'q, F, O, A>( self, query: Map<'q, Postgres, F, A>, ) -> Result<Option<O>, Error>
where F: FnMut(PgRow) -> Result<O, Error> + Send, O: Send + Unpin, A: 'q + Send + IntoArguments<'q, Postgres>,

Proxy call to query.fetch_optional but guarantees the inner executor will only be used once.

Trait Implementations§

Source§

impl<'c, E> Debug for OneTimeExecutor<'c, E>
where E: Executor<'c, Database = Db> + 'c + Debug,

Source§

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

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

impl<'c, E> Executor<'c> for OneTimeExecutor<'c, E>
where E: Executor<'c, Database = Db> + 'c,

Source§

type Database = Postgres

Source§

fn fetch_many<'e, 'q: 'e, Q>( self, query: Q, ) -> BoxStream<'e, Result<Either<<Db as Database>::QueryResult, Row>, Error>>
where Q: 'q + Execute<'q, Db>, 'c: 'e,

Execute multiple queries and return the generated results as a stream from each query, in a stream.
Source§

fn fetch_optional<'e, 'q: 'e, Q>( self, query: Q, ) -> BoxFuture<'e, Result<Option<Row>, Error>>
where Q: 'q + Execute<'q, Db>, 'c: 'e,

Execute the query and returns at most one row.
Source§

fn prepare_with<'e, 'q: 'e>( self, sql: &'q str, parameters: &'e [<Db as Database>::TypeInfo], ) -> BoxFuture<'e, Result<<Db as Database>::Statement<'q>, Error>>
where 'c: 'e,

Prepare the SQL query, with parameter type information, to inspect the type information about its parameters and results. Read more
Source§

fn execute<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the total number of rows affected.
Source§

fn execute_many<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::QueryResult, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute multiple queries and return the rows affected from each query, in a stream.
Source§

fn fetch<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Stream<Item = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return the generated results as a stream.
Source§

fn fetch_all<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<Vec<<Self::Database as Database>::Row>, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and return all the generated results, collected into a Vec.
Source§

fn fetch_one<'e, 'q, E>( self, query: E, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Row, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e, E: 'q + Execute<'q, Self::Database>,

Execute the query and returns exactly one row.
Source§

fn prepare<'e, 'q>( self, query: &'q str, ) -> Pin<Box<dyn Future<Output = Result<<Self::Database as Database>::Statement<'q>, Error>> + Send + 'e>>
where 'q: 'e, 'c: 'e,

Prepare the SQL query to inspect the type information of its parameters and results. Read more
Source§

impl<'c, E> IntoOneTimeExecutorAt<'c> for OneTimeExecutor<'c, E>
where E: Executor<'c, Database = Db> + 'c,

Source§

type Executor = E

The concrete executor type.
Source§

fn into_executor(self) -> OneTimeExecutor<'c, Self::Executor>
where Self: 'c,

Transforms into a OneTimeExecutor which can be used to execute a round trip.

Auto Trait Implementations§

§

impl<'c, E> Freeze for OneTimeExecutor<'c, E>
where E: Freeze,

§

impl<'c, E> RefUnwindSafe for OneTimeExecutor<'c, E>
where E: RefUnwindSafe,

§

impl<'c, E> Send for OneTimeExecutor<'c, E>

§

impl<'c, E> Sync for OneTimeExecutor<'c, E>
where E: Sync,

§

impl<'c, E> Unpin for OneTimeExecutor<'c, E>
where E: Unpin,

§

impl<'c, E> UnsafeUnpin for OneTimeExecutor<'c, E>
where E: UnsafeUnpin,

§

impl<'c, E> UnwindSafe for OneTimeExecutor<'c, E>
where E: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'c, T> IntoOneTimeExecutor<'c> for T
where T: IntoOneTimeExecutorAt<'c> + 'c,

Source§

impl<'c, T> PgExecutor<'c> for T
where T: Executor<'c, Database = Postgres>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more