Enum CaptureEnd 

pub enum CaptureEnd {
    Owned {
        owner: StreamId,
    },
    Abandoned {
        owner: StreamId,
    },
}

What StreamCapture::end found when it closed the window: the caller’s own capture, or one belonging to a logical stream that never came back to close it.

Both close the window. Only the owner gets a graph out of it: the failures raised inside the window doom the recording, and sealing it for a caller that never saw them would hand back a graph silently missing whatever they rejected.

Refusing a foreign caller outright is the worse trade. Several logical streams share one pooled stream, and a window nobody closes rejects every read, write and sync that lands on the slot while recording launches into a graph no one can seal: the slot is lost for the life of the process. A foreign end_capture is a caller whose StreamId moved out from under it (see the type docs), which is exactly the case where the owner is gone — so the window is torn down and the failure reported, rather than kept for an owner that will never ask.

Variants

Owned

The caller opened this window: its recording may be sealed into a graph.

Fields

owner: StreamId

The logical stream that opened the window, which is the caller.

Abandoned

The window belonged to owner, not to the caller. It is closed, but there is no graph to hand back: the backend tears the recording down and reports, and a later end_capture from owner finds nothing recording.

Fields

owner: StreamId

The logical stream that opened the window, which the report names so the caller can see whose recording was discarded.

Implementations

impl CaptureEnd

pub fn owner(&self) -> StreamId

The logical stream the window belonged to.

pub fn is_abandoned(&self) -> bool

Whether the window was closed for a caller that did not own it, so its recording is torn down instead of sealed.

pub fn abandoned_error( &self, caller: StreamId, doomed: Option<ServerError>, ) -> ServerError

The report a caller gets for closing a window it did not open: why the recording was discarded, and then doomed — the failure that had already sunk the recording, if one had, so the caller learns both reasons rather than only the one that happened to be checked last.

Only meaningful once is_abandoned says so; an owned window is the caller’s to seal and has nothing to report.

Trait Implementations

impl Clone for CaptureEnd

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CaptureEnd

impl Debug for CaptureEnd

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

Formats the value using the given formatter.

impl Eq for CaptureEnd

impl PartialEq for CaptureEnd

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaptureEnd