Skip to main content

SharedFile

Struct SharedFile 

Source
pub struct SharedFile(/* private fields */);
Expand description

A file handle this crate can read/write through without the caller having to prove it outlives every operation pushed against it (M8, PR #20 review response).

Backed by Arc<OwnedHandle> rather than Token’s exclusive-ownership shape: unlike a buffer, 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 method (e.g. Batch::read, as opposed to its _raw sibling) clones this Arc into the same Token that already tracks the operation’s own payload, so the underlying handle survives until that token is claimed or leaked (D-4 in DESIGN-NOTES.md), regardless of what the caller does with its own clone.

Implementations§

Source§

impl SharedFile

Source

pub fn new(handle: OwnedHandle) -> Self

Wrap an owned handle so it can be read/written through the ring safely.

Trait Implementations§

Source§

impl Clone for SharedFile

Source§

fn clone(&self) -> SharedFile

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SharedFile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FileTarget for SharedFile

Source§

type Guard = SharedFile

What the operation’s Token must hold until its completion is observed.
Source§

fn as_file_ref(&self) -> FileRef

How this target addresses its file.
Source§

fn guard(&self) -> Self::Guard

Produce the value the Token will hold for the operation’s duration.
Source§

impl From<OwnedHandle> for SharedFile

Source§

fn from(handle: OwnedHandle) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.