Skip to main content

RealtimeFrameCompletionMechanism

Trait RealtimeFrameCompletionMechanism 

Source
pub trait RealtimeFrameCompletionMechanism<T, M, R> {
    type Completion;
    type Error;

    // Required method
    fn complete(
        &mut self,
        input: MaterializedRealtimeInput<T>,
        output: &CompletedRealtimeFrame<T, T>,
        model_state: &M,
        payload_history: &RealtimePayloadHistory<T>,
        execution: Option<R>,
    ) -> Result<Self::Completion, RealtimeCompletionCreationError<Self::Completion, Self::Error>>;

    // Provided method
    fn retained_resources(&self, _completion: &Self::Completion) -> usize { ... }
}
Expand description

Narrow exact-completion mechanism for a fully interpreted frame.

The mechanism may retain output, history, and model-state native resources, but it cannot inspect portable frame source/target semantics.

Required Associated Types§

Source

type Completion

Exact completion object attached to the generation branch.

Source

type Error

Native submission or retention failure.

Required Methods§

Source

fn complete( &mut self, input: MaterializedRealtimeInput<T>, output: &CompletedRealtimeFrame<T, T>, model_state: &M, payload_history: &RealtimePayloadHistory<T>, execution: Option<R>, ) -> Result<Self::Completion, RealtimeCompletionCreationError<Self::Completion, Self::Error>>

Submits or records all work required by the completed unpublished frame.

Provided Methods§

Source

fn retained_resources(&self, _completion: &Self::Completion) -> usize

Reports the exact number of resources explicitly owned by a completion.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§