Skip to main content

Message

Enum Message 

Source
pub enum Message {
    Hello {
        format: u32,
        workspace_id: GrainId,
        replica_id: ReplicaId,
        vv: VersionVector,
        max_file_size: u64,
        acks: bool,
    },
    Updates(Vec<PathUpdate>),
    Done,
    Want(ContentHash),
    Missing(ContentHash),
    Aborted(ContentHash),
    Settled,
    Live(Vec<PathUpdate>),
    Refused(String),
    Ack(VersionVector),
}
Expand description

One control message.

Variants§

§

Hello

The first message from each side.

Fields

§format: u32

Session format this side speaks.

§workspace_id: GrainId

Which workspace this session is about.

§replica_id: ReplicaId

The sender’s replica id.

§vv: VersionVector

Everything the sender already has.

§max_file_size: u64

The largest file the sender writes, in bytes. The peer sends nothing larger unasked: content over it would be refused as a protocol error.

§acks: bool

Whether the sender answers a Message::Live push with Message::Ack, and reads one. Absent from a peer older than acknowledgements: false, and no Ack is ever sent to it.

§

Updates(Vec<PathUpdate>)

A page of path states the peer’s version vector does not cover.

§

Done

The sender has sent every Updates page it had.

§

Want(ContentHash)

The sender needs the content behind this hash.

§

Missing(ContentHash)

The sender does not have the content behind this hash either.

§

Aborted(ContentHash)

The sender started this content and could not finish it: the file changed under it.

Sent in place of the content’s BLOB_END. The receiver discards what it got and treats the hash as Message::Missing.

§

Settled

The sender will ask for nothing further, and has answered every Want it will get.

Sent after the peer’s Done, once this side’s want list is empty — at which point it cannot grow again. Without it a side that stopped reading at Done would drop the Want the peer sends after applying a page, and every file over the inline limit would silently never arrive.

§

Live(Vec<PathUpdate>)

A push of path states sent after the initial exchange, while the session stays open.

§

Refused(String)

The sender will not continue, and why.

§

Ack(VersionVector)

The sender has everything this version vector covers: the path states, and the content behind them on disk (or answered Missing by whoever was asked).

Sent in the live phase, after the Live batches it answers have been applied, and only to a peer whose Hello said acks. It is what lets the pushing side know a local edit has left the device, rather than only that it was queued.

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Message

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Message

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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