Struct scc::ebr::Ptr

source ·

pub struct Ptr<'b, T> { /* private fields */ }

Expand description

Ptr points to an instance.

Implementations§

source §

impl<'b, T> Ptr<'b, T>

source

pub const fn null() -> Self

Creates a null Ptr.

Examples

use scc::ebr::Ptr;

let ptr: Ptr<usize> = Ptr::null();

source

pub fn is_null(&self) -> bool

Returns true if the Ptr is null.

Examples

use scc::ebr::Ptr;

let ptr: Ptr<usize> = Ptr::null();
assert!(ptr.is_null());

source

pub fn as_ref(&self) -> Option<&'b T>

Tries to create a reference to the underlying instance.

Examples

use scc::ebr::{AtomicArc, Barrier};
use std::sync::atomic::Ordering::Relaxed;

let atomic_arc: AtomicArc<usize> = AtomicArc::new(21);
let barrier = Barrier::new();
let ptr = atomic_arc.load(Relaxed, &barrier);
assert_eq!(*ptr.as_ref().unwrap(), 21);

source

pub fn as_raw(&self) -> *const T

Returns a raw pointer to the instance.

Examples

use scc::ebr::{Arc, Barrier};
use std::sync::atomic::Ordering::Relaxed;

let arc: Arc<usize> = Arc::new(29);
let barrier = Barrier::new();
let ptr = arc.ptr(&barrier);
assert_eq!(unsafe { *ptr.as_raw() }, 29);

source

pub fn tag(&self) -> Tag

Returns its Tag.

Examples

use scc::ebr::{Ptr, Tag};

let ptr: Ptr<usize> = Ptr::null();
assert_eq!(ptr.tag(), Tag::None);

source

pub fn set_tag(&mut self, tag: Tag) -> Tag

Sets a Tag, overwriting its existing Tag.

Returns the previous tag value.

Examples

use scc::ebr::{Ptr, Tag};

let mut ptr: Ptr<usize> = Ptr::null();
assert_eq!(ptr.set_tag(Tag::Both), Tag::None);
assert_eq!(ptr.tag(), Tag::Both);

source

pub fn unset_tag(&mut self) -> Tag

Clears its Tag.

Returns the previous tag value.

Examples

use scc::ebr::{Ptr, Tag};

let mut ptr: Ptr<usize> = Ptr::null().with_tag(Tag::Both);
assert_eq!(ptr.unset_tag(), Tag::Both);

source

pub fn with_tag(self, tag: Tag) -> Self

Returns a copy of self with a Tag set.

Examples

use scc::ebr::{Ptr, Tag};

let mut ptr: Ptr<usize> = Ptr::null();
assert_eq!(ptr.tag(), Tag::None);

let ptr_with_tag = ptr.with_tag(Tag::First);
assert_eq!(ptr_with_tag.tag(), Tag::First);

source

pub fn without_tag(self) -> Self

Returns a copy of self with its Tag erased.

Examples

use scc::ebr::{Ptr, Tag};

let mut ptr: Ptr<usize> = Ptr::null();
ptr.set_tag(Tag::Second);
assert_eq!(ptr.tag(), Tag::Second);

let ptr_without_tag = ptr.without_tag();
assert_eq!(ptr_without_tag.tag(), Tag::None);

source

pub fn get_arc(self) -> Option<Arc<T>>

Tries to convert itself into an Arc.

Examples

use scc::ebr::{Arc, Barrier};

let arc: Arc<usize> = Arc::new(83);
let barrier = Barrier::new();
let ptr = arc.ptr(&barrier);
let converted_arc = ptr.get_arc().unwrap();
assert_eq!(*converted_arc, 83);

drop(arc);
drop(converted_arc);

assert!(ptr.get_arc().is_none());