Skip to main content

LiveSession

Struct LiveSession 

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

A session that stays open after the initial exchange.

Dropping it closes the session; close is the same thing said out loud.

Implementations§

Source§

impl LiveSession

Source

pub async fn push(&self, updates: Vec<PathUpdate>) -> Result<()>

Send updates to the peer.

Fails rather than waiting once the session has closed, so a caller looping over peers does not stall on one that went away.

Source

pub fn updates(&self) -> Receiver<Vec<PathUpdate>>

Updates that arrived from the peer, after they were applied.

A batch is published once every hash it was waiting on has been answered — with the bytes, or with Missing — so a subscriber forwarding it forwards what this host can answer for.

Source

pub fn peer_vv(&self) -> VersionVector

Everything the peer is known to have.

Consulted before forwarding: an entry the peer already covers must not be sent again, or three connected hosts will pass one edit round in a circle. It advances as the peer’s batches arrive, because each one carries what the peer had when it sent it.

It also advances when the peer acknowledges a push (see the module docs), so it covers this side’s own entries once they have reached the peer.

Source

pub fn acknowledged(&self) -> Receiver<VersionVector>

peer_vv as it changes: marked changed whenever an arriving batch or an acknowledgement advances it. Closed once the session is.

Starts at what the initial exchange left: what the peer said it had, plus everything this side sent it then — the exchange completes only once the peer has all of that.

Source

pub fn peer_acknowledges(&self) -> bool

Whether the peer acknowledges pushes. false for a peer from before acknowledgements: what this side pushes to it never shows in peer_vv until a later exchange.

Source

pub fn is_open(&self) -> bool

Is the session still usable?

Source

pub fn close(self)

Close it.

Trait Implementations§

Source§

impl Drop for LiveSession

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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