pub struct Owned<T> { /* 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
sourceimpl<T> Owned<T>
impl<T> Owned<T>
sourcepub fn new(value: T) -> Owned<T>
pub fn new(value: T) -> Owned<T>
Allocates value
on the heap and returns a new owned pointer pointing to it.
Examples
use crossbeam_epoch::Owned;
let o = Owned::new(1234);
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.
Examples
use crossbeam_epoch::Owned;
let o = unsafe { Owned::from_raw(Box::into_raw(Box::new(1234))) };
sourcepub fn into_box(self) -> Box<T, Global>
pub fn into_box(self) -> Box<T, Global>
Converts the owned pointer into a Box
.
Examples
use crossbeam_epoch::{self as epoch, Owned};
let o = Owned::new(1234);
let b: Box<i32> = o.into_box();
assert_eq!(*b, 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);