Struct zebra_network::peer::error::ErrorSlot

pub struct ErrorSlot(Arc<Mutex<Option<SharedPeerError>>>);

A shared error slot for peer errors.

Correctness

Error slots are shared between sync and async code. In async code, the error mutex should be held for as short a time as possible. This avoids blocking the async task thread on acquiring the mutex.

If the value behind the mutex is just data, it’s usually appropriate to use a blocking mutex … wrap the Arc<Mutex<...>> in a struct that provides non-async methods for performing operations on the data within, and only lock the mutex inside these methods

https://docs.rs/tokio/1.15.0/tokio/sync/struct.Mutex.html#which-kind-of-mutex-should-you-use

Tuple Fields

0: Arc<Mutex<Option<SharedPeerError>>>

Implementations

impl ErrorSlot

pub fn try_get_error(&self) -> Option<SharedPeerError>

Read the current error in the slot.

Returns None if there is no error in the slot.

Correctness

Briefly locks the error slot’s threaded std::sync::Mutex, to get a reference to the error in the slot.

pub fn try_update_error(&self, e: SharedPeerError) -> Result<(), AlreadyErrored>

Update the current error in the slot.

Returns Err(AlreadyErrored) if there was already an error in the slot.

Correctness

Briefly locks the error slot’s threaded std::sync::Mutex, to check for a previous error, then update the error in the slot.

Trait Implementations

impl Clone for ErrorSlot

fn clone(&self) -> ErrorSlot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorSlot

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

Formats the value using the given formatter.

impl Default for ErrorSlot

fn default() -> ErrorSlot

Returns the “default value” for a type.