[][src]Struct crossbeam::epoch::Owned

pub struct Owned<T> where
    T: Pointable + ?Sized
{ /* fields omitted */ }

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

impl<T> Owned<T>[src]

pub unsafe fn from_raw(raw: *mut T) -> Owned<T>[src]

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))) };

pub fn into_box(self) -> Box<T>[src]

Converts the owned pointer into a Box.

Examples

use crossbeam_epoch::Owned;

let o = Owned::new(1234);
let b: Box<i32> = o.into_box();
assert_eq!(*b, 1234);

pub fn new(init: T) -> Owned<T>[src]

Allocates value on the heap and returns a new owned pointer pointing to it.

Examples

use crossbeam_epoch::Owned;

let o = Owned::new(1234);

impl<T> Owned<T> where
    T: Pointable + ?Sized
[src]

pub fn init(init: <T as Pointable>::Init) -> Owned<T>[src]

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);

pub fn into_shared(self, &'g Guard) -> Shared<'g, T>[src]

Converts the owned pointer into a Shared.

Examples

use crossbeam_epoch::{self as epoch, Owned};

let o = Owned::new(1234);
let guard = &epoch::pin();
let p = o.into_shared(guard);

pub fn tag(&self) -> usize[src]

Returns the tag stored within the pointer.

Examples

use crossbeam_epoch::Owned;

assert_eq!(Owned::new(1234).tag(), 0);

pub fn with_tag(self, tag: usize) -> Owned<T>[src]

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

impl<T> AsMut<T> for Owned<T> where
    T: Pointable + ?Sized
[src]

impl<T> AsRef<T> for Owned<T> where
    T: Pointable + ?Sized
[src]

impl<T> Borrow<T> for Owned<T> where
    T: Pointable + ?Sized
[src]

impl<T> BorrowMut<T> for Owned<T> where
    T: Pointable + ?Sized
[src]

impl<T> Clone for Owned<T> where
    T: Clone
[src]

impl<T> Debug for Owned<T> where
    T: Pointable + ?Sized
[src]

impl<T> Deref for Owned<T> where
    T: Pointable + ?Sized
[src]

type Target = T

The resulting type after dereferencing.

impl<T> DerefMut for Owned<T> where
    T: Pointable + ?Sized
[src]

impl<T> Drop for Owned<T> where
    T: Pointable + ?Sized
[src]

impl<T> From<Box<T>> for Owned<T>[src]

fn from(b: Box<T>) -> Owned<T>[src]

Returns a new owned pointer pointing to b.

Panics

Panics if the pointer (the Box) is not properly aligned.

Examples

use crossbeam_epoch::Owned;

let o = unsafe { Owned::from_raw(Box::into_raw(Box::new(1234))) };

impl<T> From<Owned<T>> for Atomic<T> where
    T: Pointable + ?Sized
[src]

fn from(owned: Owned<T>) -> Atomic<T>[src]

Returns a new atomic pointer pointing to owned.

Examples

use crossbeam_epoch::{Atomic, Owned};

let a = Atomic::<i32>::from(Owned::new(1234));

impl<T> From<T> for Owned<T>[src]

impl<T> Pointer<T> for Owned<T> where
    T: Pointable + ?Sized
[src]

unsafe fn from_usize(data: usize) -> Owned<T>[src]

Returns a new pointer pointing to the tagged pointer data.

Panics

Panics if the data is zero in debug mode.

Auto Trait Implementations

impl<T: ?Sized> RefUnwindSafe for Owned<T> where
    T: RefUnwindSafe

impl<T: ?Sized> Send for Owned<T> where
    T: Send

impl<T: ?Sized> Sync for Owned<T> where
    T: Sync

impl<T: ?Sized> Unpin for Owned<T>

impl<T: ?Sized> UnwindSafe for Owned<T> where
    T: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<!> for T[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.