Skip to main content

BackgroundExecution

Struct BackgroundExecution 

Source
pub struct BackgroundExecution {
Show 15 fields pub execution_id: ExecutionId, pub tenant_id: TenantId, pub callable_name: String, pub input: Option<String>, pub context: Option<HashMap<String, String>>, pub config: BackgroundExecutionConfig, pub status: BackgroundExecutionStatus, pub queued_at: DateTime<Utc>, pub started_at: Option<DateTime<Utc>>, pub completed_at: Option<DateTime<Utc>>, pub output: Option<Value>, pub error: Option<ExecutionError>, pub target_binding_applied: bool, pub trigger_id: Option<TriggerId>, pub metadata: Option<HashMap<String, Value>>,
}
Expand description

BackgroundExecution - A background execution record @see packages/enact-schemas/src/execution.schemas.ts - backgroundExecutionSchema

Fields§

§execution_id: ExecutionId

Execution ID

§tenant_id: TenantId

Tenant that owns this execution

§callable_name: String

Callable to invoke

§input: Option<String>

Input to pass to the callable

§context: Option<HashMap<String, String>>

Context to pass

§config: BackgroundExecutionConfig

Configuration

§status: BackgroundExecutionStatus

Current status

§queued_at: DateTime<Utc>

When execution was queued

§started_at: Option<DateTime<Utc>>

When execution started

§completed_at: Option<DateTime<Utc>>

When execution completed

§output: Option<Value>

Output (populated on completion)

§error: Option<ExecutionError>

Error (populated on failure)

§target_binding_applied: bool

Whether target binding was applied

§trigger_id: Option<TriggerId>

Trigger that spawned this execution (if any)

§metadata: Option<HashMap<String, Value>>

Metadata

Implementations§

Source§

impl BackgroundExecution

Source

pub fn new( tenant_id: TenantId, callable_name: impl Into<String>, config: BackgroundExecutionConfig, ) -> Self

Create a new background execution

Source

pub fn from_trigger( tenant_id: TenantId, trigger_id: TriggerId, callable_name: impl Into<String>, input: Option<String>, context: Option<HashMap<String, String>>, target_binding: Option<TargetBindingConfig>, retry: Option<RetryConfig>, ) -> Self

Create from a trigger

Source

pub fn from_spawn_mode( spawn_mode: &SpawnMode, tenant_id: TenantId, callable_name: impl Into<String>, input: Option<String>, context: Option<HashMap<String, String>>, ) -> Option<Self>

Create from SpawnMode::Child

This bridges the gap between SpawnMode::Child { background: true, .. } and the BackgroundExecution infrastructure.

@see docs/TECHNICAL/32-SPAWN-MODE.md

Source

pub fn should_run_background(spawn_mode: &SpawnMode) -> bool

Check if a SpawnMode should create a background execution

Source

pub fn start(&mut self)

Mark execution as started

Source

pub fn complete(&mut self, output: Value)

Mark execution as completed

Source

pub fn fail(&mut self, error: ExecutionError)

Mark execution as failed

Source

pub fn cancel(&mut self)

Mark execution as cancelled

Source

pub fn timeout(&mut self)

Mark execution as timed out

Source

pub fn is_finished(&self) -> bool

Check if execution has completed (successfully or not)

Source

pub fn is_success(&self) -> bool

Check if execution succeeded

Source

pub fn duration_ms(&self) -> Option<i64>

Calculate execution duration

Source

pub fn is_silent(&self) -> bool

Check if execution should suppress streaming events (silent mode)

Source

pub fn requires_result(&self) -> bool

Check if execution requires waiting for result

Trait Implementations§

Source§

impl Clone for BackgroundExecution

Source§

fn clone(&self) -> BackgroundExecution

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BackgroundExecution

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for BackgroundExecution

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for BackgroundExecution

Source§

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

Serialize this value into the given Serde serializer. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,