Struct jormungandr::leadership::LeadershipLogHandle

pub struct LeadershipLogHandle {
    internal_id: LeadershipLogId,
    logs: Logs,
}

leadership log handle. will allow to update the status of the log without having to hold the Logs

Fields

internal_id: LeadershipLogId

logs: Logs

Implementations

impl LeadershipLogHandle

pub async fn mark_wake(&self)

make a leadership event as triggered.

This should be called when the leadership event has started.

panic

on non-release build, this function will panic if the log was already marked as awaken.

pub async fn set_status(&self, status: LeadershipLogStatus)

pub async fn mark_finished(&self)

make a leadership event as finished.

This should be called when the leadership event has finished its scheduled action.

panic

on non-release build, this function will panic if the log was already marked as finished.

Trait Implementations

impl Clone for LeadershipLogHandle

fn clone(&self) -> LeadershipLogHandle

Returns a copy of the value.

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

Performs copy-assignment from source.