Struct CancelKeyMap 

pub struct CancelKeyMap { /* private fields */ }

Client-facing cancellation keys mapped to their current upstream keys.

Implementations

impl CancelKeyMap

pub fn new() -> Self

Creates an empty in-memory cancellation-key registry.

pub fn register( &mut self, client: CancelKey, upstream: CancelKey, ) -> Result<(), RegisterError>

Registers one proxy-minted client key for an attached upstream session.

Errors

Rejects keys outside the protocol’s 4–256 byte range and client-key collisions. Existing mappings are never silently replaced.

pub fn resolve(&self, process_id: u32, secret_key: &[u8]) -> Option<&CancelKey>

Resolves an inspected client CancelRequest to its upstream key.

pub fn remove(&mut self, client: &CancelKey) -> Option<CancelKey>

Detaches a client key when its upstream session is released or replaced.

pub fn len(&self) -> usize

Returns the number of live client-to-upstream mappings.

pub fn is_empty(&self) -> bool

Returns whether the registry contains no mappings.

Trait Implementations

impl CancelKeyRegistry for CancelKeyMap

type Error = RegisterError

Error returned when a key association cannot be registered.

fn register_cancel_key( &mut self, client: CancelKey, upstream: CancelKey, ) -> Result<(), Self::Error>

Observes the association between a client-facing and upstream key.

fn resolve_cancel_key(&self, client: &CancelKey) -> Option<CancelKey>

Resolves an incoming client cancellation request without borrowing the registry, so the result can safely cross an asynchronous boundary.

fn remove_cancel_key(&mut self, client: &CancelKey) -> Option<CancelKey>

Removes an association when either side of a session is detached.

impl Debug for CancelKeyMap

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

Formats the value using the given formatter.

impl Default for CancelKeyMap

fn default() -> CancelKeyMap

Returns the “default value” for a type.