Struct SharedBoxRef 

pub struct SharedBoxRef<T: ?Sized> { /* private fields */ }

A Reference to SharedBox that can be sent to other threads.

Dropping a SharedBoxRef leaks the heap memory it points to. When panic-on-drop feature is enabled, dropping it will panic:

let mut b = manual_share::SharedBox::new(1);
b.borrow();

// forget SharedBox to make sure the panic is not caused by dropping it first.
std::mem::forget(b);

// panic here due to dropping SharedBoxRef

Use SharedBox::try_return to consume it without causing panic.

let mut b = manual_share::SharedBox::new(1);
let r = b.borrow();
b.try_return(r).unwrap();

Implementations

impl<T: ?Sized> SharedBoxRef<T>

pub fn get(&self) -> &T

Example usage:

let mut b = manual_share::SharedBox::new(42);
let r = b.borrow();
let value = *r.get();
assert_eq!(value, 42);

b.try_return(r).unwrap();

The reference got from this method has the same lifetime of the SharedBoxRef, which means it will be invalidated after SharedBoxRef is given back to SharedBox:

let mut b = manual_share::SharedBox::new(42);
let br = b.borrow();
let r = br.get();

b.try_return(br).unwrap();

// r is no longer valid here.
println!("{}", r);

Trait Implementations

impl<T: Debug + ?Sized> Debug for SharedBoxRef<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for SharedBoxRef<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Sync> Send for SharedBoxRef<T>

SharedBoxRef is like &T, which only requires T: Sync to implement Send.

impl<T: Sync> Sync for SharedBoxRef<T>