Struct thingvellir::DataLoadRequest

#[must_use =
  "the data load request must be resolved or rejected, otherwise the operation will be considered aborted."]pub struct DataLoadRequest<Key, Data> { /* fields omitted */ }

The data load request is passed to [LoadFromUpstream::load] handler.

It contains methods to notify the shard that the data has finished loading, or has failed to load.

If the DataLoadRequest is dropped, without sending a result, the shard will receive an UpstreamError::OperationAborted for the given key being loaded. This prevents leaking load requests due to code error, where a code-path did not use the data load request.

Implementations

impl<Key, Data> DataLoadRequest<Key, Data>

pub fn key(&self) -> &Key

Returns a reference to the key that is currently being loaded.

pub fn resolve(self, data: Data)

Resolves the data load request with the given data.

pub fn reject<E: Into<UpstreamError>>(self, error: E)

Rejects the data load request with a given error. The error must be able to be converted into an UpstreamError.

impl<Key: Send + 'static, Data: ServiceData> DataLoadRequest<Key, Data>

pub fn spawn<F: Future<Output = Result<Data, UpstreamError>> + Send + 'static>(
    self,
    fut: F
)

Convenience method to spawn a task to drive a future to completion, and capture that future's result in order to reject or resolve the data load request.

impl<Key: Send + 'static, Data: ServiceData + Default> DataLoadRequest<Key, Data>

pub fn spawn_default<F: Future<Output = Result<Data, UpstreamError>> + Send + 'static>(
    self,
    fut: F
)

Similar to spawn, however, in event of encountering a UpstreamError::KeyNotFound, error will resolve with the value of Data::default.

Trait Implementations

impl<Key, Data> Drop for DataLoadRequest<Key, Data>

fn drop(&mut self)

Executes the destructor for this type.