Struct fedimint_client::oplog::OperationLogEntry

pub struct OperationLogEntry { /* private fields */ }

Represents an operation triggered by a user, typically related to sending or receiving money.

There are three levels of introspection possible for OperationLogEntrys:

1. The OperationLogEntry::operation_module_kind function returns the kind of the module that created the operation.
2. The OperationLogEntry::meta function returns static meta data that was associated with the operation when it was created. Modules define their own meta structures, so the module kind has to be used to determine the structure of the meta data.
3. To find out the current state of the operation there is a two-step process: * First, the OperationLogEntry::outcome function returns the outcome if the operation finished and the update subscription stream has been processed till its end at least once. * If that isn’t the case, the OperationLogEntry::outcome method will return None and the appropriate update subscription function has to be called. See the respective client extension trait for these functions.

Implementations

impl OperationLogEntry

pub fn operation_module_kind(&self) -> &str

Returns the kind of the module that generated the operation

pub fn meta<M: DeserializeOwned>(&self) -> M

Returns the meta data of the operation. This is a JSON value that can be either returned as a serde_json::Value or deserialized into a specific type. The specific type should be named <Module>OperationMeta in the module’s client crate. The module can be determined by calling OperationLogEntry::operation_module_kind.

pub fn outcome<D: DeserializeOwned>(&self) -> Option<D>

Returns the last state update of the operation, if any was cached yet. If this hasn’t been the case yet and None is returned subscribe to the appropriate update stream.

Determining the return type

OperationLogEntry::meta should tell you the which operation type of a given module the outcome belongs to. The operation type will have a corresponding async fn subscribe_type(&self, operation_id: OperationId) -> anyhow::Result<UpdateStreamOrOutcome<TypeState>>; function that returns a UpdateStreamOrOutcome<S> where S is the high-level state the operation is in. If this state is terminal, i.e. the stream closes after returning it, it will be cached as the outcome of the operation.

This means the type to be used for deserializing the outcome is S, often called <OperationType>State. Alternatively one can also use serde_json::Value to get the unstructured data.

pub fn outcome_or_updates<U, S>( &self, db: &Database, operation_id: OperationId, stream_gen: impl FnOnce() -> S ) -> UpdateStreamOrOutcome<U>

where U: Clone + Serialize + DeserializeOwned + Debug + MaybeSend + MaybeSync + 'static, S: Stream<Item = U> + MaybeSend + 'static,

Returns an a UpdateStreamOrOutcome enum that can be converted into an update stream for easier handling using UpdateStreamOrOutcome::into_stream but can also be matched over to shortcut the handling of final outcomes.

Trait Implementations

impl Debug for OperationLogEntry

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

Formats the value using the given formatter.

impl Decodable for OperationLogEntry

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry ) -> Result<Self, DecodeError>

Decode an object with a well-defined format

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode> ) -> Result<Self, DecodeError>

Decode an object from hex

impl<'de> Deserialize<'de> for OperationLogEntry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for OperationLogEntry

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Result<Vec<u8>, Error>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> Result<String, Error>

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl Serialize for OperationLogEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.