Skip to main content

SqliteReadStream

Struct SqliteReadStream 

pub struct SqliteReadStream { /* private fields */ }
Available on crate feature event-store only.
Expand description

The stream SqliteEventStore::read returns.

§Why this type is Send

Nothing here is Send by accident, and each piece earns it separately:

  • the cursor holds Arc<Mutex<Connection>>, and Mutex<T>: Sync whenever T: Send — so wrapping the !Sync [Connection] is what makes the whole cursor Send;
  • [JoinHandle<T>] is Send when T is, and T here is the cursor plus a Result<Page, SqliteEventStoreError>, whose error wraps rusqlite::Error (Send + Sync) and [JoinError];
  • the drain state holds vec::IntoIter<SequencedEvent>, Send because SequencedEvent is.

No rusqlite handle that borrows the connection — Statement, Rows, Transaction — ever appears in a field, and that is the load-bearing part: all three are !Send, so holding one across the poll_next boundary would cost the stream its Send-ness and with it the SendEventStore impl. Confining them to the inside of the blocking closure is not a style choice.

The type is also Unpin — every field is — so poll_next needs no pin projection and no unsafe, which matters because unsafe_code is forbidden workspace-wide.

Trait Implementations§

§

impl Debug for SqliteReadStream

§

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

Formats the value using the given formatter. Read more
§

impl Stream for SqliteReadStream

§

type Item = Result<SequencedEvent, SqliteEventStoreError>

Values yielded by the stream.
§

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more
§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations§

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

impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

§

type Ok = T

The type of successful values yielded by this future
§

type Error = E

The type of failures yielded by this future
§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more