Struct FileStream 

pub struct FileStream { /* private fields */ }

A subscription descriptor for one stream key in the file.

A plain descriptor follows the live tail; where reading begins is the framework’s start_at(..) clause with a FilePosition (or a live seek through the SeekHandle context key). replay is the one reading mode the position API cannot express: it reads the finished file and completes the stream at its end instead of following live writes.

Implements SubscriptionSource, so it can sit inline in the #[subscriber(..)] decorator, and IntoSource, so the manual path’s subscriber(..) constructor takes it the way it takes a subject string. The FileStream page shows it in a service.

Examples

A replay of a recorded file:

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

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

#[subscriber(FileStream::new("orders").replay())]
async fn audit(order: &Order) -> HandlerOutcome {
    tracing::info!(order.id, "audited");
    HandlerOutcome::ack()
}

#[ruststream::app]
fn app() -> impl App {
    RustStream::new(AppInfo::new("audit", "0.1.0"))
        .with_broker(FileBroker::new("/var/lib/orders.ss").existing_only(), |b| {
            b.include(audit);
        })
}

Implementations

impl FileStream

pub fn new(stream: impl Into<String>) -> Self

Names the stream key.

pub fn replay(self) -> Self

Replays the retained file from the beginning instead of following live writes; the subscription completes at the end of the file.

Every message the file holds is delivered before the subscription completes. The end is the end-of-stream mark a writer left with end_with_eos, or the end of the file when there is none.

pub fn stream(&self) -> &str

The stream key this descriptor resolves.

Trait Implementations

impl Clone for FileStream

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileStream

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

Formats the value using the given formatter.

impl Eq for FileStream

impl IntoSource for FileStream

type Source = FileStream

The source the constructor stores.

fn into_source(self) -> Self

Builds the source.

impl PartialEq for FileStream

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

Equality operator ==.

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

Inequality operator !=.

impl RedeliveryAddressed<ConnectedFileBroker> for FileStream

fn redelivery_address( &self, _connected: &ConnectedFileBroker, ) -> impl Future<Output = Result<RedeliveryAddress, SeaFileError>>

Where a publish reaches this subscription again.

impl StructuralPartialEq for FileStream

impl SubscriptionSource<ConnectedFileBroker> for FileStream

type Subscriber = FileSubscriber

The subscriber type this source opens.

type Copies = AddressedCopies

Who publishes the copies this subscription’s retries are made of, and who names where they go: AddressedCopies, NamedCopies or BrokerMoves.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, connected: &ConnectedFileBroker, ) -> Result<FileSubscriber, SeaFileError>

Opens the subscription against the connected broker. Called once at startup.

fn channel_bindings(&self) -> Bindings

What this subscription adds to its channel in the generated AsyncAPI document.

fn declare_retry(self, declaration: &RetryDeclaration) -> Self

where Self: Sized,

Takes the registration’s retry declaration into the descriptor, before the subscription opens.

fn declare_retry_on( &self, connected: &C, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

Carries the registration’s declaration to the broker, at the same point and before the subscription opens.

fn operation_bindings(&self) -> Bindings

What this subscription adds to its receive operation in the document.

fn message_bindings(&self) -> Bindings

What this subscription adds to the messages that arrive on it.