Skip to main content

CutoverContext

Struct CutoverContext 

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

What a participant hook is told about the cutover it is part of.

Implementations§

Source§

impl CutoverContext

Source

pub fn id(&self) -> &str

The cutover id (random, fresh for each attempt, persisted in the record).

Source

pub fn generation(&self) -> u64

The generation number: 1 for the first attempt at this new root, one more for each rerun after an abort or an interruption. A service can fence stale replies with it.

Source

pub fn old_root(&self) -> &Path

The canonical old root. Participants must treat it as read-only.

Source

pub fn new_root(&self) -> &Path

The canonical new root.

Source

pub fn resumed(&self) -> bool

True when this attempt follows an earlier one that did not complete, or finishes a switched cutover after a restart. Hooks must be idempotent: work an earlier attempt already finished is verified, not redone or refused.

Source

pub fn authoritative(&self, settlement: Settlement) -> &Path

The root a participant must be using after settlement.

Trait Implementations§

Source§

impl Clone for CutoverContext

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 CutoverContext

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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