Struct static_rc::rc::StaticRc [−][src]
Expand description
A compile-time reference-counted pointer.
The inherent methods of StaticRc
are all associated functions to avoid conflicts with the the methods of the
inner type T
which are brought into scope by the Deref
implementation.
The parameters NUM
and DEN
DENote the ratio (NUM / DEN
) of ownership of the pointer:
- The ratio is always in the (0, 1] interval, that is:
NUM > 0
andNUM <= DEN
. - When the ratio is equal to 1, that is when
NUM == DEN
, then the instance has full ownership of the pointee and extra capabilities are unlocked.
Implementations
Constructs a new StaticRc<T, N, N>
.
This uses Box
under the hood.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 1, 1>;
let rc = Full::new(42);
assert_eq!(42, *rc);
Constructs a new Pin<StaticRc<T, N, N>>
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 1, 1>;
let rc = Full::pin(42);
assert_eq!(42, *rc);
Returns the inner value.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 1, 1>;
let rc = Full::new(42);
assert_eq!(42, Full::into_inner(rc));
Returns a mutable reference into the given StaticRc
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 1, 1>;
let mut rc = Full::new(42);
let r: &mut i32 = Full::get_mut(&mut rc);
*r = 33;
assert_eq!(33, *rc);
Consumes the StaticRc
, returning the wrapped pointer.
To avoid a memory leak, the pointer must be converted back to Self
using StaticRc::from_raw
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 1, 1>;
let rc = Full::new(42);
let leaked = Full::into_raw(rc);
let rc = unsafe { Full::from_raw(leaked) };
assert_eq!(42, *rc);
Provides a raw pointer to the data.
StaticRc
is not consumed or affected in any way, the pointer is valid as long as there are shared owners of
the value.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 1, 1>;
let rc = Full::new(42);
let pointer = Full::as_ptr(&rc);
assert_eq!(42, unsafe { *pointer.as_ref() });
Provides a reference to the data.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 1, 1>;
let rc = Full::new(42);
assert_eq!(42, *Full::get_ref(&rc));
Constructs a StaticRc<T, NUM, DEN>
from a raw pointer.
Safety
The raw pointer must have been previously returned by a call to StaticRc<U, N, D>::into_raw
:
- If
U
is different fromT
, then specific restrictions on size and alignment apply. Seemem::transmute
for the restrictions applying to transmuting references. - If
N / D
is different fromNUM / DEN
, then specific restrictions apply. The user is responsible for ensuring proper management of the ratio of shares, and ultimately that the value is not dropped twice.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 2, 2>;
type Half = StaticRc<i32, 1, 2>;
let rc = Full::new(42);
let leaked = Full::into_raw(rc);
let (one, two) = unsafe { (Half::from_raw(leaked), Half::from_raw(leaked)) };
let rc = Full::join(one, two);
assert_eq!(42, *rc);
Returns true if the two StaticRc
point to the same allocation.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 2, 2>;
let rc = Full::new(42);
let (one, two) = Full::split::<1, 1>(rc);
assert!(StaticRc::ptr_eq(&one, &two));
Full::join(one, two);
Adjusts the NUMerator and DENUMerator of the ratio of the instance, preserving the ratio.
Panics
If the compile-time-ratio feature is not used, and the ratio is not preserved; that is N / D <> NUM / DEN
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 2, 2>;
let rc = Full::new(42);
let rc = Full::adjust::<1, 1>(rc);
assert_eq!(42, *rc);
Splits the current instance into two instances with the specified NUMerators.
Panics
If the compile-time-ratio feature is not used, and the ratio is not preserved; that is A + B <> NUM
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 2, 2>;
type Half = StaticRc<i32, 1, 2>;
let rc = Full::new(42);
let (one, two): (Half, Half) = Full::split::<1, 1>(rc);
assert_eq!(42, *one);
Full::join(one, two);
Splits the current instance into DIM
instances with the specified Numerators and Denominators.
Panics
If the compile-time-ratio feature is not used, and the ratio is not preserved; that is N * DIM <> NUM
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 2, 2>;
let rc = Full::new(42);
let array = Full::split_array::<1, 2>(rc);
assert_eq!(42, *array[0]);
Full::join_array(array);
Joins two instances into a single instance.
Panics
If the two instances do no point to the same allocation, as determined by StaticRc::ptr_eq
.
If the compile-time-ratio feature is not used and the ratio is not preserved; that is A + B <> NUM
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 3, 3>;
let rc = Full::new(42);
let (one, two) = Full::split::<1, 2>(rc);
let rc = Full::join(one, two);
assert_eq!(42, *rc);
Joins two instances into a single instance without checking whether they point to the same allocation.
Unless compile-time-ratio
is activated, the ratios are checked nevertheless.
Safety
The caller must guarantee that those instances point to the same allocation.
Panics
If the compile-time-ratio feature is not used and the ratio is not preserved; that is A + B <> NUM
.
In debug, if the two instances do not point to the same allocation, as determined by StaticRc::ptr_eq
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 3, 3>;
let rc = Full::new(42);
let (one, two) = Full::split::<1, 2>(rc);
let rc = unsafe { Full::join_unchecked(one, two) };
assert_eq!(42, *rc);
Joins DIM instances into a single instance.
Panics
If all instances do not point to the same allocation, as determined by StaticRc::ptr_eq
.
If the compile-time-ratio feature is not used and the ratio is not preserved; that is N * DIM <> NUM
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 2, 2>;
let rc = Full::new(42);
let array = Full::split_array::<1, 2>(rc);
let rc = Full::join_array(array);
assert_eq!(42, *rc);
Joins DIM instances into a single instance.
Panics
If the compile-time-ratio feature is not used and the ratio is not preserved; that is N * DIM <> NUM
.
In debug, if all instances do not point to the same allocation, as determined by StaticRc::ptr_eq
.
Example
use static_rc::StaticRc;
type Full = StaticRc<i32, 2, 2>;
let rc = Full::new(42);
let array = Full::split_array::<1, 2>(rc);
let rc = unsafe { Full::join_array_unchecked(array) };
assert_eq!(42, *rc);
Trait Implementations
Mutably borrows from an owned value. Read more
impl<I: DoubleEndedIterator + ?Sized, const N: usize> DoubleEndedIterator for StaticRc<I, N, N>
impl<I: DoubleEndedIterator + ?Sized, const N: usize> DoubleEndedIterator for StaticRc<I, N, N>
Removes and returns an element from the end of the iterator. Read more
Returns the n
th element from the end of the iterator. Read more
🔬 This is a nightly-only experimental API. (iter_advance_by
)
recently added
Advances the iterator from the back by n
elements. Read more
This is the reverse version of Iterator::try_fold()
: it takes
elements starting from the back of the iterator. Read more
An iterator method that reduces the iterator’s elements to a single, final value, starting from the back. Read more
Creates a value from an iterator. Read more
Advances the iterator and returns the next value. Read more
Returns the bounds on the remaining length of the iterator. Read more
Returns the n
th element of the iterator. Read more
Consumes the iterator, counting the number of iterations and returning it. Read more
🔬 This is a nightly-only experimental API. (iter_advance_by
)
recently added
Advances the iterator by n
elements. Read more
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
1.0.0[src]fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,
Takes two iterators and creates a new iterator over both in sequence. Read more
1.0.0[src]fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,
‘Zips up’ two iterators into a single iterator of pairs. Read more
🔬 This is a nightly-only experimental API. (iter_intersperse
)
recently added
Creates a new iterator which places a copy of separator
between adjacent
items of the original iterator. Read more
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
G: FnMut() -> Self::Item,
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
G: FnMut() -> Self::Item,
🔬 This is a nightly-only experimental API. (iter_intersperse
)
recently added
Creates a new iterator which places an item generated by separator
between adjacent items of the original iterator. Read more
Takes a closure and creates an iterator which calls that closure on each element. Read more
Calls a closure on each element of an iterator. Read more
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
Creates an iterator that both filters and maps. Read more
Creates an iterator which gives the current iteration count as well as the next value. Read more
Creates an iterator that yields elements based on a predicate. Read more
Creates an iterator that both yields elements based on a predicate and maps. Read more
Creates an iterator that skips the first n
elements. Read more
Creates an iterator that yields the first n
elements, or fewer
if the underlying iterator ends sooner. Read more
Creates an iterator that works like map, but flattens nested structure. Read more
Creates an iterator that flattens nested structure. Read more
Does something with each element of an iterator, passing the value on. Read more
Transforms an iterator into a collection. Read more
Consumes an iterator, creating two collections from it. Read more
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
T: 'a,
Self: DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
T: 'a,
Self: DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,
🔬 This is a nightly-only experimental API. (iter_partition_in_place
)
new API
Reorders the elements of this iterator in-place according to the given predicate,
such that all those that return true
precede all those that return false
.
Returns the number of true
elements found. Read more
🔬 This is a nightly-only experimental API. (iter_is_partitioned
)
new API
Checks if the elements of this iterator are partitioned according to the given predicate,
such that all those that return true
precede all those that return false
. Read more
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
Folds every element into an accumulator by applying an operation, returning the final result. Read more
Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
Tests if every element of the iterator matches a predicate. Read more
Tests if any element of the iterator matches a predicate. Read more
Searches for an element of an iterator that satisfies a predicate. Read more
Applies function to the elements of iterator and returns the first non-none result. Read more
🔬 This is a nightly-only experimental API. (try_find
)
new API
Applies function to the elements of iterator and returns the first true result or the first error. Read more
Searches for an element in an iterator, returning its index. Read more
1.0.0[src]fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,
Searches for an element in an iterator from the right, returning its index. Read more
Returns the maximum element of an iterator. Read more
Returns the minimum element of an iterator. Read more
Returns the element that gives the maximum value from the specified function. Read more
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
Returns the element that gives the minimum value from the specified function. Read more
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
Reverses an iterator’s direction. Read more
Converts an iterator of pairs into a pair of containers. Read more
Creates an iterator which copies all of its elements. Read more
Sums the elements of an iterator. Read more
Iterates over the entire iterator, multiplying all the elements Read more
Lexicographically compares the elements of this Iterator
with those
of another. Read more
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
iter_order_by
)Lexicographically compares the elements of this Iterator
with those
of another with respect to the specified comparison function. Read more
1.5.0[src]fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Lexicographically compares the elements of this Iterator
with those
of another. Read more
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
iter_order_by
)Lexicographically compares the elements of this Iterator
with those
of another with respect to the specified comparison function. Read more
1.5.0[src]fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn eq_by<I, F>(self, other: I, eq: F) -> bool where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
fn eq_by<I, F>(self, other: I, eq: F) -> bool where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
iter_order_by
)1.5.0[src]fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,
1.5.0[src]fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
less than those of another. Read more
1.5.0[src]fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
less or equal to those of another. Read more
1.5.0[src]fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
greater than those of another. Read more
1.5.0[src]fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,
Determines if the elements of this Iterator
are lexicographically
greater than or equal to those of another. Read more
🔬 This is a nightly-only experimental API. (is_sorted
)
new API
Checks if the elements of this iterator are sorted. Read more
🔬 This is a nightly-only experimental API. (is_sorted
)
new API
Checks if the elements of this iterator are sorted using the given comparator function. Read more
fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,
fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,
🔬 This is a nightly-only experimental API. (is_sorted
)
new API
Checks if the elements of this iterator are sorted using the given key extraction function. Read more
impl<T, const NUM: usize, const DEN: usize, const N: usize, const D: usize> PartialOrd<StaticRc<T, N, D>> for StaticRc<T, NUM, DEN> where
T: ?Sized + PartialOrd<T>,
impl<T, const NUM: usize, const DEN: usize, const N: usize, const D: usize> PartialOrd<StaticRc<T, N, D>> for StaticRc<T, NUM, DEN> where
T: ?Sized + PartialOrd<T>,
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl<T: ?Sized, const NUM: usize, const DEN: usize> RefUnwindSafe for StaticRc<T, NUM, DEN> where
T: RefUnwindSafe,
impl<T: ?Sized, const NUM: usize, const DEN: usize> UnwindSafe for StaticRc<T, NUM, DEN> where
T: RefUnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
into_future
)The output that the future will produce on completion.
type Future = F
type Future = F
into_future
)Which kind of future are we turning this into?
into_future
)Creates a future from a value.