Skip to main content

RecordProcessResult

Enum RecordProcessResult 

Source
pub enum RecordProcessResult {
    Complete,
    AsyncPending,
    AsyncPendingNotify(Vec<(String, EpicsValue)>),
    CompleteNoEmit,
    CompleteDeferOutput,
    CompleteAlarmOnly,
}
Expand description

Result of a record’s process() call.

Determines how the framework handles the current processing cycle. Side-effect actions (link writes, delayed reprocess, etc.) are expressed separately in ProcessOutcome::actions.

Variants§

§

Complete

Processing completed synchronously this cycle. Framework proceeds with alarm/timestamp/snapshot/OUT/FLNK.

§

AsyncPending

Processing started but not yet complete (PACT stays set). Current cycle skips alarm/timestamp/snapshot/OUT/FLNK. ProcessActions (if any) are still executed.

§

AsyncPendingNotify(Vec<(String, EpicsValue)>)

Async pending, but notify these intermediate field changes immediately. Used by motor records to flush DMOV=0 before the move completes.

§

CompleteNoEmit

Completed synchronously (PACT cleared, unlike AsyncPending), but the record produced no new value to publish this cycle — the framework must skip the value-publication epilogue (UDF clear / timestamp / monitor / FLNK). C parity compressRecord.c:365 if (status != 1): a compress record still accumulating toward its next compressed sample runs none of recGblGetTimeStamp / monitor / recGblFwdLink on that cycle.

§

CompleteDeferOutput

Ran the value-publication epilogue NOW (UDF clear / timestamp / monitor — VAL and the alarm fields are posted this cycle), but the OUTPUT side (OUT link write / OEVT / forward link) is deferred to a scheduled reprocess, with PACT held across the wait. C parity swaitRecord.c::process (lines 425-481): when schedOutput arms the ODLY watchdog it sets async=TRUE, so process still runs monitor() (line 475) — posting the value side at the START of the delay — but skips the if(!async) {recGblFwdLink; pact=FALSE;} tail; the deferred execOutput (watchdog, at delay-END) does the OUT write + OEVT + forward link and posts no monitors. Unlike the calcout/scalcout/acalcout family, whose C process returns BEFORE monitor() (calcoutRecord.c:282, only dlya posted), so they defer the value side too and use AsyncPendingNotify. The deferral must carry a ProcessAction::ReprocessAfter — that scheduled reprocess is the continuation that releases the held PACT (same by-construction invariant as the AsyncPendingNotify ODLY defer).

§

CompleteAlarmOnly

Completed synchronously (PACT cleared), and the framework runs the ALARM epilogue ONLY: the UDF update, check_alarms, recGblResetAlarms (committing SEVR/STAT/AMSG and posting those fields with their C masks) and the timestamp. The VALUE side is skipped entirely — no monitor() value posts (so the last-posted trackers stay put and the next publishing cycle re-detects the change, exactly as C leaves LA..LP un-updated), no OUT / OEVT write, no process actions, no forward link.

C parity transformRecord.c:554-560: an INVALID input severity with IVLA == transformIVLA_DO_NOTHING makes process() run recGblGetTimeStamp + checkAlarms + recGblResetAlarms, clear pact and return — skipping the calc loop, all 16 OUTx dbPutLink writes, monitor() and recGblFwdLink().

Distinct from RecordProcessResult::CompleteNoEmit, which skips the alarm commit and the timestamp too (C compressRecord.c:365 returns before checkAlarms).

Trait Implementations§

Source§

impl Clone for RecordProcessResult

Source§

fn clone(&self) -> RecordProcessResult

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecordProcessResult

Source§

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

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

impl PartialEq for RecordProcessResult

Source§

fn eq(&self, other: &RecordProcessResult) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RecordProcessResult

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> 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<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