Struct Ptr

Source

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

Expand description

Ptr points to an instance.

Implementations§

Source §

impl<'g, T> Ptr<'g, T>

Source

pub const fn null() -> Self

Creates a null Ptr.

§Examples

use sdd::Ptr;

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

Source

pub fn is_null(&self) -> bool

Returns true if the Ptr is null.

§Examples

use sdd::Ptr;

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

Source

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

Tries to create a reference to the underlying instance.

§Examples

use sdd::{AtomicShared, Guard};
use std::sync::atomic::Ordering::Relaxed;

let atomic_shared: AtomicShared<usize> = AtomicShared::new(21);
let guard = Guard::new();
let ptr = atomic_shared.load(Relaxed, &guard);
assert_eq!(*ptr.as_ref().unwrap(), 21);

Source

pub const unsafe fn as_ref_unchecked(&self) -> Option<&'g T>

Tries to create a reference to the underlying instance without checking tag bits.

§Safety

This Ptr must not have any tag bits set, otherwise dereferencing the pointer may lead to undefined behavior.

§Examples

use sdd::{AtomicShared, Guard};
use std::sync::atomic::Ordering::Relaxed;

let atomic_shared: AtomicShared<usize> = AtomicShared::new(21);
let guard = Guard::new();
let ptr = atomic_shared.load(Relaxed, &guard);
assert_eq!(unsafe { *ptr.as_ref_unchecked().unwrap() }, 21);

Source

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

Provides a raw pointer to the instance.

§Examples

use sdd::{Guard, Shared};
use std::sync::atomic::Ordering::Relaxed;

let shared: Shared<usize> = Shared::new(29);
let guard = Guard::new();
let ptr = shared.get_guarded_ptr(&guard);
drop(shared);

assert_eq!(unsafe { *ptr.as_ptr() }, 29);

Source

pub const unsafe fn as_ptr_unchecked(&self) -> *const T

Tries to create a pointer to the underlying instance without checking tag bits.

§Safety

This Ptr must not have any tag bits set, otherwise dereferencing the pointer may lead to undefined behavior.

§Examples

use sdd::{AtomicShared, Guard};
use std::sync::atomic::Ordering::Relaxed;

let atomic_shared: AtomicShared<usize> = AtomicShared::new(21);
let guard = Guard::new();
let ptr = atomic_shared.load(Relaxed, &guard);
assert_eq!(unsafe { *ptr.as_ptr_unchecked() }, 21);

Source

pub fn tag(&self) -> Tag

Returns its Tag.

§Examples

use sdd::{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 sdd::{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 sdd::{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 sdd::{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 sdd::{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_shared(self) -> Option<Shared<T>>

Tries to convert itself into a Shared.

§Examples

use sdd::{Guard, Shared};

let shared: Shared<usize> = Shared::new(83);
let guard = Guard::new();
let ptr = shared.get_guarded_ptr(&guard);
let shared_restored = ptr.get_shared().unwrap();
assert_eq!(*shared_restored, 83);

drop(shared);
drop(shared_restored);

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