SamodLoader

Struct SamodLoader 

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

A state machine for loading a samod repository.

SamodLoader handles the initialization phase of a samod repository, coordinating between the user and the driver to load or generate the storage ID and perform any other setup operations required before the repository can be used.

§Usage

use samod_core::{PeerId, SamodLoader, LoaderState, UnixTimestamp, io::{StorageResult, IoResult}};
use rand::SeedableRng;

let mut rng = rand::rngs::StdRng::from_rng(&mut rand::rng());
let mut loader = SamodLoader::new(PeerId::from("test"));

loop {
    match loader.step(&mut rng, UnixTimestamp::now()) {
        LoaderState::NeedIo(tasks) => {
            // Execute IO tasks and provide results
            for task in tasks {
                // ... execute task ...
                loader.provide_io_result(result);
            }
        }
        LoaderState::Loaded(samod) => {
            // Repository is loaded and ready to use
            break;
        }
    }
}

Implementations§

Source§

impl SamodLoader

Source

pub fn new(local_peer_id: PeerId) -> Self

Creates a new samod loader.

§Arguments
  • now - The current timestamp for initialization
§Returns

A new SamodLoader ready to begin the loading process.

Source

pub fn step<R: Rng>(&mut self, rng: &mut R, _now: UnixTimestamp) -> LoaderState

Advances the loader state machine.

This method should be called repeatedly until LoaderState::Loaded is returned. When LoaderState::NeedIo is returned, the caller must execute the provided IO tasks and call provide_io_result for each one before calling step again.

§Arguments
  • now - The current timestamp
§Returns

The current state of the loader.

Source

pub fn provide_io_result(&mut self, result: IoResult<StorageResult>)

Provides the result of an IO operation.

This method should be called for each IO task that was returned by step. The loader passes the result directly to the driver for processing.

§Arguments
  • result - The result of executing an IO task

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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