[−][src]Struct counting_pointer::Asc
A thread-safe strong reference-counting pointer. 'Asc' stands for 'Atomic Strong Counted.'
It behaves like std::Sync::Arc
except for that this treats only strong pointer; i.e. Asc
gives up weak pointer for the performance.
The inherent methods of Asc
are all associated funcitons, which means that you have to call
them as e.g., Asc::get_mut(&mut value)
instead of value.get_mut()
. This avoids conflicts
with methods of the inner type T
.
Thread Safety
Unlike to Sc
, Asc
uses atomic operations for its reference counting. This means that it
is thread-safe. The disadvangate is that atomic operations are more expensive than ordinary
memory access.
Implementations
impl<T, A> Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
pub fn new(val: T, alloc: A) -> Self
[src]
Creates a new instance.
Examples
use std::alloc::System; use counting_pointer::Asc; let _five = Asc::new(5, System);
pub fn from_slice_alloc(vals: &[T], alloc: A) -> Asc<[T], A> where
T: Clone,
[src]
T: Clone,
Creates a new instance of Asc<[T], A>
.
Examples
use std::alloc::System; use counting_pointer::Asc; let vals: [i32; 4] = [0, 1, 2, 3]; let sc = Asc::from_slice_alloc(&vals, System); assert_eq!(&vals, &*sc);
impl<A> Asc<dyn Any, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
pub fn new_any<T>(val: T, alloc: A) -> Self where
T: Any,
[src]
T: Any,
Creates Asc<dyn Any>
instance.
Examples
use std::alloc::System; use counting_pointer::Asc; let _five = Asc::new_any(5, System);
impl<T, A> Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
pub fn to_any(this: Self) -> Asc<dyn Any, A> where
T: Any,
[src]
T: Any,
Consumes this
, returning Asc<dyn Any, A>
Examples
use counting_pointer::Asc; let sc: Asc<i32> = Asc::from(6); let any = Asc::to_any(sc);
impl<T: ?Sized, A> Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
pub fn as_ptr(this: &Self) -> *const T
[src]
Provides a raw pointer to the data.
The counts are not affected in any way and the Asc
is not consumed. The pointer is valid
for as long as another Asc
instance is pointing to the address.
Examples
use counting_pointer::Asc; let x: Asc<String> = Asc::from(String::from("Hello")); let x_ptr = Asc::as_ptr(&x); assert_eq!("Hello", unsafe { &*x_ptr });
pub fn count(this: &Self) -> usize
[src]
Returns the number of Asc
pointers pointing to the same address.
Examples
use counting_pointer::Asc; let five: Asc<i32> = Asc::from(5); assert_eq!(1, Asc::count(&five)); let _also_five = five.clone(); assert_eq!(2, Asc::count(&five)); assert_eq!(2, Asc::count(&_also_five)); drop(five); assert_eq!(1, Asc::count(&_also_five));
pub fn get_mut(this: &mut Self) -> Option<&mut T>
[src]
Returns a mutable reference into the given Asc
, if no other Asc
instance is pointing to
the same address; otherwise returns None
.
See also make_mut
, which will clone
the inner value when some other Asc
instances
are.
Examples
use counting_pointer::Asc; let mut x: Asc<i32> = Asc::from(3); assert_eq!(3, *x); *Asc::get_mut(&mut x).unwrap() = 4; assert_eq!(4, *x); let _y = x.clone(); let n = Asc::get_mut(&mut x); assert!(n.is_none());
pub fn ptr_eq(this: &Self, other: &Self) -> bool
[src]
Returns true
if the two Asc
instances point to the same address, or false
.
Examples
use counting_pointer::Asc; let five: Asc<i32> = Asc::from(5); let same_five = five.clone(); let other_five: Asc<i32> = Asc::from(5); assert_eq!(true, Asc::ptr_eq(&five, &same_five)); assert_eq!(false, Asc::ptr_eq(&five, &other_five));
pub fn into_raw_alloc(this: Self) -> (*const T, A)
[src]
Consumes this
, returning the wrapped pointer and the allocator.
To avoid memory leak, the returned pointer must be converted back to an Asc
using
from_raw_alloc
.
Using this function and from_raw_alloc
, user can create an Asc<T: ?Sized>
instance.
Examples
use counting_pointer::Asc; let asc: Asc<String> = Asc::from("Foo".to_string()); let (ptr, alloc) = Asc::into_raw_alloc(asc); let _asc: Asc<dyn AsRef<str>> = unsafe { Asc::from_raw_alloc(ptr, alloc) };
pub unsafe fn from_raw_alloc(ptr: *const T, alloc: A) -> Self
[src]
Constructs a new instance from a raw pointer and allocator.
The raw pointer must have been previously returned by a call to into_raw_alloc
.
Using this function and into_raw_alloc
, user can create an Asc<T: ?Sized>
instance.
Safety
It may lead to memory unsafety to use improperly, even if the returned value will never be accessed.
Examples
use counting_pointer::Asc; let asc: Asc<String> = Asc::from("Foo".to_string()); let (ptr, alloc) = Asc::into_raw_alloc(asc); let _asc: Asc<dyn AsRef<str>> = unsafe { Asc::from_raw_alloc(ptr, alloc) };
impl<T: Clone, A: Clone> Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
pub fn make_mut(this: &mut Self) -> &mut T
[src]
Makes a mutable reference into the given Asc
.
If another Asc
instance is pointing to the same address, make_mut
will clone
the inner
value to a new allocation to ensure unique ownership.
See also get_mut
, which will fail rather than cloning.
Examples
use counting_pointer::Asc; let mut data: Asc<i32> = Asc::from(5); assert_eq!(5, *data); *Asc::make_mut(&mut data) += 1; // Won't clone anything. assert_eq!(6, *data); let mut data2 = data.clone(); // Won't clone the inner data. *Asc::make_mut(&mut data) += 1; // Clones inner data. assert_eq!(7, *data); assert_eq!(6, *data2);
impl<A> Asc<dyn Any, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
pub fn downcast<T: Any>(self) -> Result<Asc<T, A>, Self>
[src]
Attempts to downcast the Asc<dyn Any, A>
to a concrete type.
Examples
use std::alloc::System; use std::any::Any; use counting_pointer::Asc; let sc = Asc::new_any(8 as i32, System); let success = Asc::downcast::<i32>(sc.clone()).unwrap(); assert_eq!(8, *success); let fail = Asc::downcast::<String>(sc.clone()); assert_eq!(true, fail.is_err());
Trait Implementations
impl<T: ?Sized, A> AsRef<T> for Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
impl<T: ?Sized, A> Borrow<T> for Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
impl<T: ?Sized, A> Clone for Asc<T, A> where
A: Clone + GlobalAlloc,
[src]
A: Clone + GlobalAlloc,
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: ?Sized, A> Debug for Asc<T, A> where
A: Debug + GlobalAlloc,
[src]
A: Debug + GlobalAlloc,
impl<T, A> Default for Asc<T, A> where
T: Default,
A: Default + GlobalAlloc,
[src]
T: Default,
A: Default + GlobalAlloc,
impl<T: ?Sized, A> Deref for Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
impl<T: ?Sized, A> Display for Asc<T, A> where
T: Display,
A: GlobalAlloc,
[src]
T: Display,
A: GlobalAlloc,
impl<T: ?Sized, A> Drop for Asc<T, A> where
A: GlobalAlloc,
[src]
A: GlobalAlloc,
impl<T: ?Sized, A> Eq for Asc<T, A> where
T: Eq,
A: GlobalAlloc,
[src]
T: Eq,
A: GlobalAlloc,
impl<T, A, '_> From<&'_ [T]> for Asc<[T], A> where
T: Clone,
A: Default + GlobalAlloc,
[src]
T: Clone,
A: Default + GlobalAlloc,
impl<T, A> From<T> for Asc<T, A> where
A: Default + GlobalAlloc,
[src]
A: Default + GlobalAlloc,
impl<T: ?Sized, A> Hash for Asc<T, A> where
T: Hash,
A: GlobalAlloc,
[src]
T: Hash,
A: GlobalAlloc,
fn hash<H>(&self, hasher: &mut H) where
H: Hasher,
[src]
H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T: ?Sized, A> Ord for Asc<T, A> where
T: Ord,
A: GlobalAlloc,
[src]
T: Ord,
A: GlobalAlloc,
fn cmp(&self, other: &Self) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<T: ?Sized, A> PartialEq<Asc<T, A>> for Asc<T, A> where
T: PartialEq,
A: GlobalAlloc,
[src]
T: PartialEq,
A: GlobalAlloc,
impl<T: ?Sized, A> PartialOrd<Asc<T, A>> for Asc<T, A> where
T: PartialOrd,
A: GlobalAlloc,
[src]
T: PartialOrd,
A: GlobalAlloc,
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T: ?Sized, A> Send for Asc<T, A> where
T: Send + Sync,
A: Send + GlobalAlloc,
[src]
T: Send + Sync,
A: Send + GlobalAlloc,
impl<T: ?Sized, A> Sync for Asc<T, A> where
T: Send + Sync,
A: Sync + GlobalAlloc,
[src]
T: Send + Sync,
A: Sync + GlobalAlloc,
Auto Trait Implementations
impl<T: ?Sized, A> RefUnwindSafe for Asc<T, A> where
A: RefUnwindSafe,
T: RefUnwindSafe,
A: RefUnwindSafe,
T: RefUnwindSafe,
impl<T: ?Sized, A> Unpin for Asc<T, A> where
A: Unpin,
A: Unpin,
impl<T: ?Sized, A> UnwindSafe for Asc<T, A> where
A: UnwindSafe,
T: RefUnwindSafe,
A: UnwindSafe,
T: RefUnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[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]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,