Struct LibsqlStorage 

pub struct LibsqlStorage<T, C> { /* private fields */ }

LibsqlStorage is a storage backend for apalis using libsql as the database.

Implementations

impl<T> LibsqlStorage<T, ()>

pub fn new(db: &'static Database) -> LibsqlStorage<T, JsonCodec<CompactType>>

Create a new LibsqlStorage with default JSON codec

pub fn new_with_config( db: &'static Database, config: Config, ) -> LibsqlStorage<T, JsonCodec<CompactType>>

Create a new LibsqlStorage with custom config

impl<T, C> LibsqlStorage<T, C>

pub fn db(&self) -> &'static Database

Get the database reference

pub fn config(&self) -> &Config

Get the config

pub async fn setup(&self) -> Result<(), LibsqlError>

Setup the database schema by running migrations

pub fn with_codec<D>(self) -> LibsqlStorage<T, D>

Change the codec used for serialization/deserialization

impl<Args, Decode> LibsqlStorage<Args, Decode>

where Args: Send + 'static + Unpin, Decode: Codec<Args, Compact = CompactType> + 'static + Send, Decode::Error: Error + Send + Sync + 'static,

pub fn poll_default( self, worker: &WorkerContext, ) -> impl Stream<Item = Result<Option<LibsqlTask<CompactType>>, LibsqlError>> + Send + 'static

Poll for tasks using the default polling strategy

pub async fn ack<Res>( &mut self, task_id: &Ulid, result: Result<Res, BoxDynError>, ) -> Result<(), LibsqlError>

where Res: Serialize + Send,

Acknowledge a task completion

Trait Implementations

impl<Args, Decode> Backend for LibsqlStorage<Args, Decode>

where Args: Send + 'static + Unpin, Decode: Codec<Args, Compact = CompactType> + 'static + Send, Decode::Error: Error + Send + Sync + 'static,

type Args = Args

The type of arguments the backend handles.

type IdType = Ulid

The type used to uniquely identify tasks.

type Context = SqlContext

Context associated with each task.

type Error = LibsqlError

The error type returned by backend operations

type Stream = Pin<Box<dyn Stream<Item = Result<Option<Task<Args, SqlContext, Ulid>>, LibsqlError>> + Send>>

A stream of tasks provided by the backend.

type Beat = Pin<Box<dyn Stream<Item = Result<(), LibsqlError>> + Send>>

A stream representing heartbeat signals.

type Layer = Stack<LockTaskLayer, AcknowledgeLayer<LibsqlAck>>

The type representing backend middleware layer.

fn heartbeat(&self, worker: &WorkerContext) -> Self::Beat

Returns a heartbeat stream for the given worker.

fn middleware(&self) -> Self::Layer

Returns the backend’s middleware layer.

fn poll(self, worker: &WorkerContext) -> Self::Stream

Polls the backend for tasks for the given worker.

impl<Args, Decode> BackendExt for LibsqlStorage<Args, Decode>

where Args: Send + 'static + Unpin, Decode: Codec<Args, Compact = CompactType> + 'static + Send, Decode::Error: Error + Send + Sync + 'static,

type Codec = Decode

The codec used for serialization/deserialization of tasks.

type Compact = Vec<u8>

The compact representation of task arguments.

type CompactStream = Pin<Box<dyn Stream<Item = Result<Option<Task<Vec<u8>, SqlContext, Ulid>>, LibsqlError>> + Send>>

A stream of encoded tasks provided by the backend.

fn poll_compact(self, worker: &WorkerContext) -> Self::CompactStream

Polls the backend for encoded tasks for the given worker.

impl<T, C> Clone for LibsqlStorage<T, C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, C> Debug for LibsqlStorage<T, C>

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

Formats the value using the given formatter.

impl<Args, Codec> Sink<Task<Vec<u8>, SqlContext, Ulid>> for LibsqlStorage<Args, Codec>

where Args: Send + Sync + 'static,

Implementation of Sink for LibsqlStorage to push tasks

type Error = LibsqlError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: LibsqlTask<CompactType>, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<'pin, T, C> Unpin for LibsqlStorage<T, C>

where PinnedFieldsOf<__LibsqlStorage<'pin, T, C>>: Unpin,