Skip to main content

FileContext

Struct FileContext 

Source
pub struct FileContext { /* private fields */ }
Expand description

The file transport’s per-delivery context: this delivery’s position in the stream file, and the subscription’s own seeker.

The runtime builds one per delivery, and handlers read its fields by key - Position and SeekHandle. A handler that reads both, or that reads them on the manual path, names this type as its context.

§Examples

use ruststream_sea_file::file::prelude::*;
use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct Job {
    id: u64,
}

#[subscriber(FileStream::new("jobs"))]
async fn work(job: &Job, ctx: &mut Context<'_, FileContext>) -> HandlerOutcome {
    if job.id == 0 && ctx.context(SeekHandle).seek(FilePosition::end()).await.is_err() {
        return HandlerOutcome::retry();
    }
    tracing::info!(job.id, position = ?ctx.context(Position), "worked");
    HandlerOutcome::ack()
}

#[ruststream::app]
fn app() -> impl App {
    RustStream::new(AppInfo::new("jobs", "0.1.0"))
        .with_broker(FileBroker::new("/tmp/jobs.ss"), |b| {
            b.include(work);
        })
}

Trait Implementations§

Source§

impl BuildContext<FileMessage> for FileContext

Source§

fn build(msg: &FileMessage) -> Self

Builds the context value by reading fields out of msg.
Source§

impl Debug for FileContext

Source§

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

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

impl Field<FileContext> for Position

Source§

type Value<'a> = FilePosition

The value read through this key, borrowed from the source for 'a.
Source§

fn get(self, src: &FileContext) -> FilePosition

Reads this key’s field out of src.
Source§

impl Field<FileContext> for SeekHandle

Source§

type Value<'a> = &'a FileSeeker

The value read through this key, borrowed from the source for 'a.
Source§

fn get(self, src: &FileContext) -> &FileSeeker

Reads this key’s field out of src.

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> 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<T> PublishedThrough<DefaultSlot> for T

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