Struct crossbeam_epoch::Owned
source · pub struct Owned<T: ?Sized + Pointable> { /* private fields */ }
Expand description
An owned heap-allocated object.
This type is very similar to Box<T>
.
The pointer must be properly aligned. Since it is aligned, a tag can be stored into the unused least significant bits of the address.
Implementations§
source§impl<T> Owned<T>
impl<T> Owned<T>
sourcepub unsafe fn from_raw(raw: *mut T) -> Owned<T>
pub unsafe fn from_raw(raw: *mut T) -> Owned<T>
Returns a new owned pointer pointing to raw
.
This function is unsafe because improper use may lead to memory problems. Argument raw
must be a valid pointer. Also, a double-free may occur if the function is called twice on
the same raw pointer.
§Panics
Panics if raw
is not properly aligned.
§Safety
The given raw
should have been derived from Owned
, and one raw
should not be converted
back by Owned::from_raw()
multiple times.
§Examples
use crossbeam_epoch::Owned;
let o = unsafe { Owned::from_raw(Box::into_raw(Box::new(1234))) };
source§impl<T: ?Sized + Pointable> Owned<T>
impl<T: ?Sized + Pointable> Owned<T>
sourcepub fn init(init: T::Init) -> Owned<T>
pub fn init(init: T::Init) -> Owned<T>
Allocates value
on the heap and returns a new owned pointer pointing to it.
§Examples
use crossbeam_epoch::Owned;
let o = Owned::<i32>::init(1234);
sourcepub fn tag(&self) -> usize
pub fn tag(&self) -> usize
Returns the tag stored within the pointer.
§Examples
use crossbeam_epoch::Owned;
assert_eq!(Owned::new(1234).tag(), 0);
sourcepub fn with_tag(self, tag: usize) -> Owned<T>
pub fn with_tag(self, tag: usize) -> Owned<T>
Returns the same pointer, but tagged with tag
. tag
is truncated to be fit into the
unused bits of the pointer to T
.
§Examples
use crossbeam_epoch::Owned;
let o = Owned::new(0u64);
assert_eq!(o.tag(), 0);
let o = o.with_tag(2);
assert_eq!(o.tag(), 2);
Trait Implementations§
source§impl<T: ?Sized + Pointable> BorrowMut<T> for Owned<T>
impl<T: ?Sized + Pointable> BorrowMut<T> for Owned<T>
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T: ?Sized + Pointable> Pointer<T> for Owned<T>
impl<T: ?Sized + Pointable> Pointer<T> for Owned<T>
source§unsafe fn from_usize(data: usize) -> Self
unsafe fn from_usize(data: usize) -> Self
Returns a new pointer pointing to the tagged pointer data
.
§Panics
Panics if the data is zero in debug mode.