Struct CaptureSet 

pub struct CaptureSet { /* private fields */ }

Which capturable aspects a capture should collect.

There is no Default implementation; see the module documentation.

Implementations

impl CaptureSet

pub const NONE: Self

Collect nothing.

Every aspect is then Captured::NotCaptured, which leaves the target thread’s own values alone.

pub const IMPERSONATION: Self

Just the impersonation context.

pub const ERROR_MODE: Self

Just the thread error mode.

pub const TRANSACTION: Self

Just the current TxF transaction.

pub const DEFAULT: Self

The recommended starting point: impersonation and the thread error mode.

Adding an aspect to this set is a breaking change, and that is the reason it exists as a name rather than as a Default implementation.

TxF is deliberately excluded. It is deprecated by Microsoft, capturing it costs a lazy ntdll binding a caller may never need, and – the reason that actually decides it – a captured transaction enlists remoted work in a transaction the caller may commit or roll back while that work is still running. That is a hazard to opt into deliberately, not one to acquire by taking a default. Add TRANSACTION when you mean it.

pub const ALL: Self

Every capturable aspect this version knows.

This set grows. Membership is its meaning, so a later version adding an aspect will capture it here without further notice. A caller that needs a fixed set should name its aspects instead.

pub const fn union(self, other: Self) -> Self

Both sets’ aspects.

pub const fn without(self, other: Self) -> Self

This set without other’s aspects.

pub const fn contains(self, other: Self) -> bool

Whether every aspect of other is present.

pub const fn is_empty(self) -> bool

Whether nothing would be collected.

pub fn aspects(self) -> impl Iterator<Item = CapturableAspect>

The aspects in this set, in a stable order.

Trait Implementations

impl Clone for CaptureSet

fn clone(&self) -> CaptureSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CaptureSet

impl Debug for CaptureSet

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

Formats the value using the given formatter.

impl Eq for CaptureSet

impl From<CapturableAspect> for CaptureSet

fn from(aspect: CapturableAspect) -> Self

Converts to this type from the input type.

impl Hash for CaptureSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CaptureSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaptureSet