Struct ReposStream 

pub struct ReposStream {
    info: Option<Bytes>,
    producer: Weak<Inner>,
    stream: u64,
    after: u64,
    published: Receiver<u64>,
    exclude: Exclusions,
    lagged: u64,
    closing: Receiver<bool>,
}

One consumer’s stream: the replay, then whatever arrives live, both read from the replay buffer.

A plain reader rather than a Stream, because a WebSocket is written to rather than polled from — see routes::subscribe_repos.

Fields

info: Option<Bytes>

The #info OutdatedCursor frame to send before anything else.

producer: Weak<Inner>

Held weakly, so a stream does not keep a dropped producer alive.

stream: u64

This stream’s key in Ring::streams.

after: u64

The highest sequence number this stream has sent or passed over. It sends the buffer’s frames after this one. Copied to Ring::streams whenever it moves.

published: Receiver<u64>

Changes whenever a frame is buffered.

exclude: Exclusions

Which message types this consumer asked not to be sent.

lagged: u64

How many sequence numbers the buffer evicted before this consumer was sent them.

closing: Receiver<bool>

Whether the producer is closing. See Repos::close.

Implementations

impl ReposStream

pub fn lagged(&self) -> u64

How many frames this consumer has been too slow to receive.

pub async fn next(&mut self) -> Option<Bytes>

The next frame’s bytes, or None when the producer is gone, or is closing and this stream has sent what it was published.

A consumer the buffer evicted a frame from before it was sent is dropped rather than silently skipped: the lexicon has ConsumerTooSlow for exactly this, and a stream that resumed after a gap would leave a relay believing it had seen every commit.

fn read(&mut self, producer: &Inner) -> Read

The next frame after this stream’s position that it wants, moving the position past it and past any frame the exclusions drop.

Trait Implementations

impl Debug for ReposStream

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

Formats the value using the given formatter.

impl Drop for ReposStream

Gives back the frames this stream was keeping in the buffer.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.