Struct FileBroker 

pub struct FileBroker { /* private fields */ }

A persistent, replayable stream on disk for the RustStream messaging framework: what survives restarts, records for replay, and needs no external broker.

new is synchronous and records only the path; the file opens in the consuming Broker::connect. Not supported on Windows (an upstream constraint of the file client).

Examples

use ruststream_sea_file::FileBroker;

let broker = FileBroker::new("/var/lib/orders.ss");

Implementations

impl FileBroker

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

Records the path of the stream file (created on connect when missing). No I/O.

pub fn existing_only(self) -> Self

Requires the file to exist instead of creating it on connect.

pub fn end_with_eos(self) -> Self

Writes an end-of-stream mark when the broker shuts down, so replay consumers of the finished file complete instead of waiting for more data.

pub fn beacon_interval(self, bytes: u32) -> Self

The interval of the file’s in-place index (must be a positive multiple of 1024); denser beacons make seeking finer-grained at the cost of file size.

pub fn publisher(&self) -> FilePublisher

A publisher sharing this broker’s connection cell; buildable before connect.

Trait Implementations

impl Broker for FileBroker

type Error = SeaFileError

The error type returned by broker-level operations.

type Connected = ConnectedFileBroker

The connected form of this broker: the typed witness that connect succeeded.

async fn connect(self) -> Result<Self::Connected, Self::Error>

Establishes the connection to the broker, consuming the unconnected form.

fn bindable(self) -> Bindable<Self>

where Self: 'static,

Wraps the broker for publisher-token minting before registration: the returned Bindable hands out Bound tokens via its bind, and is itself what with_broker takes.

impl Clone for FileBroker

fn clone(&self) -> FileBroker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileBroker

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

Formats the value using the given formatter.

impl DescribeServer for FileBroker

fn describe_server(&self) -> ServerSpec

Returns the server coordinates for this broker.