Struct SharedHandle 

pub struct SharedHandle(/* private fields */);

A shared owner of a Windows handle: an OwnedHandle behind a reference count.

Cloning is cheap and shares the one handle; the handle closes when the last clone drops. See the crate documentation for what it does and does not do.

Implementations

impl SharedHandle

pub fn new(handle: OwnedHandle) -> SharedHandle

Take ownership of handle, as the first of its holders.

pub fn same_handle(&self, other: &SharedHandle) -> bool

Whether self and other share one handle – that is, whether one is a clone of the other, directly or not.

Two handles opened separately on the same file are not the same handle, even though they name the same file.

pub fn try_into_owned(self) -> Result<OwnedHandle, SharedHandle>

The handle, as an OwnedHandle, if self is its only holder.

Errors

If any clone still holds the handle, returns self unchanged, so nothing is lost and the caller can try again once the others have dropped.

Trait Implementations

impl AsHandle for SharedHandle

fn as_handle(&self) -> BorrowedHandle<'_>

Borrows the handle.

impl AsRawHandle for SharedHandle

fn as_raw_handle(&self) -> *mut c_void

Extracts the raw handle.

impl Clone for SharedHandle

fn clone(&self) -> SharedHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedHandle

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

Formats the value using the given formatter.

impl FileTarget for SharedHandle

A SharedHandle is how a caller gives this crate a file it does not have to prove outlives every operation pushed against it (M8; D-82). One handle is legitimately the target of many concurrent pushes, so what must survive until every one of them completes is a reference, not sole ownership. Every safe push (e.g. Batch::read_owned, as opposed to its _raw sibling) clones it into the same inventory entry that tracks the operation’s own payload, so the handle survives until the ring returns that entry at its pop (D-4), whatever the caller does with its own clone.

type Guard = SharedHandle

What the ring must hold for the operation until its completion is observed. What keeps the file valid while the operation runs.

fn as_file_ref(&self) -> FileRef

How this target addresses its file.

fn guard(&self) -> <SharedHandle as FileTarget>::Guard

Produce the value the ring will hold for the operation’s duration.

impl From<File> for SharedHandle

fn from(file: File) -> SharedHandle

Converts to this type from the input type.

impl From<OwnedHandle> for SharedHandle

fn from(handle: OwnedHandle) -> SharedHandle

Converts to this type from the input type.