Enum HandoffReport 

pub enum HandoffReport {
    Done {
        token: u64,
        heads: Vec<String>,
    },
    OwnerSubscribe {
        version: u16,
    },
    OwnerTakeover {
        token: u64,
        schema: u16,
        metadata: Vec<u8>,
    },
    Failed {
        token: u64,
        reason: String,
    },
    Retired {
        successor: Successor,
    },
}

One instance answering a handoff request, or reporting a retirement.

Variants

Done

The step is done. heads are the shown document’s heads before the step changed it, hex-encoded; empty when it changed nothing.

Fields

token: u64

heads: Vec<String>

OwnerSubscribe

Replay the latest view after this native route is acknowledged.

Fields

version: u16

OwnerTakeover

Explicit local interaction takes over this instance’s owner view.

Fields

token: u64

schema: u16

metadata: Vec<u8>

Failed

The step could not be done; nothing was retired.

Fields

token: u64

reason: String

Retired

A document this instance shows arrived retired: moved elsewhere.

Fields

successor: Successor

Implementations

impl HandoffReport

pub fn done(token: u64, heads: &[ChangeHash]) -> HandoffReport

Done, with heads as they were before the step.

pub fn encode(&self) -> Vec<u8>

pub fn decode(bytes: &[u8]) -> Option<HandoffReport>

None for anything that is not a bounded, well-formed report.

pub fn heads(&self) -> Option<Vec<ChangeHash>>

The heads a Self::Done carries; None when any is malformed.

Trait Implementations

impl Clone for HandoffReport

fn clone(&self) -> HandoffReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HandoffReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HandoffReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HandoffReport

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HandoffReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HandoffReport

impl StructuralPartialEq for HandoffReport