ReferenceAPIsRust Library Referencenemo-relayapiscope

Function pop_scope

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi.

pub fn pop_scope(params: PopScopeParams<'_>) -> Result<()>

Pop the current scope from the active scope stack.

This emits a scope-end event for the target scope and removes any scope-local registrations owned by that scope.

Parameters

  • handle_uuid: UUID of the scope that should be popped.
  • output: Optional JSON payload exported as the semantic scope output.
  • timestamp: Optional timestamp recorded on the emitted end event. When None, the runtime uses the current UTC time, or one microsecond after the handle start time if the current time is not later.

Returns

A Result that is Ok(()) when the scope was popped successfully.

Errors

Returns FlowError::InvalidArgument when the target scope exists but is not the current top of stack, and FlowError::NotFound when the UUID is unknown to the active stack.

Notes

The implicit root scope cannot be removed.