Skip to main content

InstallSnapshotRequest

Struct InstallSnapshotRequest 

Source
pub struct InstallSnapshotRequest {
    pub term: Term,
    pub leader_id: NodeId,
    pub last_included_index: LogIndex,
    pub last_included_term: Term,
    pub offset: u64,
    pub data: Vec<u8>,
    pub done: bool,
}
Expand description

InstallSnapshot RPC request (Raft paper Section 7)

Sent by the leader to followers that are too far behind in the log. The snapshot is sent in chunks identified by offset and done flag.

Fields§

§term: Term

Leader’s current term

§leader_id: NodeId

Leader’s ID so follower can redirect clients

§last_included_index: LogIndex

The last included index in the snapshot

§last_included_term: Term

The term of the last included index

§offset: u64

Byte offset into the snapshot data for chunked transfer

§data: Vec<u8>

Raw snapshot data chunk

§done: bool

True if this is the final chunk of the snapshot

Implementations§

Source§

impl InstallSnapshotRequest

Source

pub fn new_complete( term: Term, leader_id: NodeId, last_included_index: LogIndex, last_included_term: Term, data: Vec<u8>, ) -> Self

Create a new InstallSnapshot request for a complete snapshot (single chunk)

Source

pub fn new_chunk( term: Term, leader_id: NodeId, last_included_index: LogIndex, last_included_term: Term, offset: u64, data: Vec<u8>, done: bool, ) -> Self

Create a new InstallSnapshot request for a chunk of a snapshot

Source

pub fn is_complete(&self) -> bool

Check if this is a complete (non-chunked) snapshot transfer

Trait Implementations§

Source§

impl Clone for InstallSnapshotRequest

Source§

fn clone(&self) -> InstallSnapshotRequest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InstallSnapshotRequest

Source§

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

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

impl PartialEq for InstallSnapshotRequest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for InstallSnapshotRequest

Source§

impl StructuralPartialEq for InstallSnapshotRequest

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> 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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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