Struct crossbeam_epoch::atomic::Owned

pub struct Owned<H: Handle> { /* fields omitted */ }

An owned heap-allocated object.

This type is very similar to the storage type S (think: Box<H::Target>).

The pointer must be properly aligned. Since it is aligned, a tag can be stored into the unused least significant bits of the address.

Methods

impl<H: Handle> Owned<H> where
    H::Target: Sized, 

pub unsafe fn from_raw(raw: *mut H::Target) -> Owned<H>

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

impl<H: Handle> Owned<H>

pub fn into_shared<'g>(self, _: &'g Guard) -> Shared<'g, H>

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 into_handle(self) -> H

Converts the owned pointer into the underlying storage.

Examples

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

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

pub fn tag(&self) -> usize

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<H>

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

impl<T> Owned<Box<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);

Trait Implementations

impl<H: Handle> AsMut<<H as Deref>::Target> for Owned<H>

fn as_mut(&mut self) -> &mut H::Target

Performs the conversion.

impl<H: Handle> AsRef<<H as Deref>::Target> for Owned<H>

fn as_ref(&self) -> &H::Target

Performs the conversion.

impl<H: Handle> Debug for Owned<H>

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

Formats the value using the given formatter.

impl<H: Handle> Deref for Owned<H>

type Target = H::Target

The resulting type after dereferencing.

fn deref(&self) -> &H::Target

Dereferences the value.

impl<H: Handle> DerefMut for Owned<H>

fn deref_mut(&mut self) -> &mut H::Target

Mutably dereferences the value.

impl<H: Handle> Drop for Owned<H>

fn drop(&mut self)

Executes the destructor for this type.

impl<H: Handle> From<H> for Owned<H>

fn from(handle: H) -> Self

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::<i32>::from(Box::new(1234)) };

impl<H: Handle> From<Owned<H>> for Atomic<H>

fn from(owned: Owned<H>) -> Self

Returns a new atomic pointer pointing to owned.

Examples

use crossbeam_epoch::{Atomic, Owned};

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

impl<H: Handle> Pointer<H> for Owned<H>

fn into_usize(self) -> usize

Returns the machine representation of the pointer.

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.