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>

source

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

pub fn into_box(self) -> Box<T>

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

pub fn new(init: 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);
source§

impl<T: ?Sized + Pointable> Owned<T>

source

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

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

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

pub fn tag(&self) -> usize

Returns the tag stored within the pointer.

Examples
use crossbeam_epoch::Owned;

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

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> AsMut<T> for Owned<T>

source§

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl<T: ?Sized + Pointable> AsRef<T> for Owned<T>

source§

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl<T: ?Sized + Pointable> Borrow<T> for Owned<T>

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T: ?Sized + Pointable> BorrowMut<T> for Owned<T>

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T: Clone> Clone for Owned<T>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<T: ?Sized + Pointable> Debug for Owned<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: ?Sized + Pointable> Deref for Owned<T>

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

impl<T: ?Sized + Pointable> DerefMut for Owned<T>

source§

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.
source§

impl<T: ?Sized + Pointable> Drop for Owned<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T> From<Box<T, Global>> for Owned<T>

source§

fn from(b: Box<T>) -> 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::from_raw(Box::into_raw(Box::new(1234))) };
source§

impl<T: ?Sized + Pointable> From<Owned<T>> for Atomic<T>

source§

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

Returns a new atomic pointer pointing to owned.

Examples
use crossbeam_epoch::{Atomic, Owned};

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

impl<T> From<T> for Owned<T>

source§

fn from(t: T) -> Self

Converts to this type from the input type.
source§

impl<T: ?Sized + Pointable> Pointer<T> for Owned<T>

source§

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.

source§

fn into_usize(self) -> usize

Returns the machine representation of the pointer.

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§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pointable for T

source§

const ALIGN: usize = const ALIGN: usize = mem::align_of::<T>();

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.