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 Seek parameter). 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:

use ruststream_sea_file::FileStream;

let live = FileStream::new("orders");
let batch = FileStream::new("orders").replay();

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 and ends at its tail instead of following live writes; the subscription completes at the end of the file.

pub fn stream(&self) -> &str

The stream key this descriptor resolves.

Trait Implementations

impl Clone for FileStream

fn clone(&self) -> FileStream

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 PartialEq for FileStream

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FileStream

impl SubscriptionSource<ConnectedFileBroker> for FileStream

type Subscriber = FileSubscriber

The subscriber type this source opens.

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.