Struct StaticRc

Source
pub struct StaticRc<T: ?Sized, const NUM: usize, const DEN: usize> { /* private fields */ }
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 and NUM <= 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§

Source§

impl<T, const N: usize> StaticRc<T, N, N>

Source

pub fn new(value: T) -> Self
where (): Sized,

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

pub fn pin(value: T) -> Pin<Self>
where (): Sized,

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

pub fn into_inner(this: Self) -> T

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));
Source§

impl<T: ?Sized, const N: usize> StaticRc<T, N, N>

Source

pub fn get_mut(this: &mut Self) -> &mut T

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

pub fn into_box(this: Self) -> Box<T>

Returns the inner value, boxed

§Example
use static_rc::StaticRc;

type Full = StaticRc<i32, 1, 1>;

let mut rc = Full::new(42);
let boxed: Box<_> = Full::into_box(rc);
assert_eq!(42, *boxed);
Source§

impl<T: ?Sized, const NUM: usize, const DEN: usize> StaticRc<T, NUM, DEN>

Source

pub fn into_raw(this: Self) -> NonNull<T>

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

pub fn as_ptr(this: &Self) -> NonNull<T>

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() });
Source

pub fn get_ref(this: &Self) -> &T

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

pub unsafe fn from_raw(pointer: NonNull<T>) -> Self
where (): Sized,

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 from T, then specific restrictions on size and alignment apply. See mem::transmute for the restrictions applying to transmuting references.
  • If N / D is different from NUM / 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);
Source

pub fn ptr_eq<const N: usize, const D: usize>( this: &Self, other: &StaticRc<T, N, D>, ) -> bool

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

pub fn adjust<const N: usize, const D: usize>(this: Self) -> StaticRc<T, N, D>
where (): Sized, ((), ()): Sized,

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

pub fn as_rcref<'a>(this: &'a mut Self) -> StaticRcRef<'a, T, NUM, DEN>
where (): Sized,

Converts an instance into a StaticRcRef.

The current instance is mutably borrowed for the duration the result can be used.

§Example
use static_rc::StaticRc;
use static_rc::StaticRcRef;
let rc: StaticRc<_, 2, 2> = StaticRc::new(5);
let (mut rc1, mut rc2) = StaticRc::split::<1, 1>(rc);
{
    // Modify without moving `rc1`, `rc2`.
    let rcref1 = StaticRc::as_rcref(&mut rc1);
    let rcref2 = StaticRc::as_rcref(&mut rc2);
    let mut rcref_owning: StaticRcRef<_, 2, 2> = StaticRcRef::join(rcref1, rcref2);
    *rcref_owning = 9;
    // Refs not used anymore, original rcs can be used again
}
let rc: StaticRc<_, 2, 2> = StaticRc::join(rc1, rc2);
assert_eq!(*rc, 9);
assert_eq!(*StaticRc::into_box(rc), 9);
Source

pub fn split<const A: usize, const B: usize>( this: Self, ) -> (StaticRc<T, A, DEN>, StaticRc<T, B, DEN>)
where (): Sized, ((), ()): Sized,

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

pub fn split_array<const N: usize, const DIM: usize>( this: Self, ) -> [StaticRc<T, N, DEN>; DIM]
where ((), ()): Sized, (): Sized,

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

pub fn join<const A: usize, const B: usize>( left: StaticRc<T, A, DEN>, right: StaticRc<T, B, DEN>, ) -> Self
where ((), ()): Sized,

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

pub unsafe fn join_unchecked<const A: usize, const B: usize>( left: StaticRc<T, A, DEN>, right: StaticRc<T, B, DEN>, ) -> Self
where ((), ()): Sized,

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

pub fn join_array<const N: usize, const DIM: usize>( array: [StaticRc<T, N, DEN>; DIM], ) -> Self
where (): Sized, ((), ()): Sized,

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

pub unsafe fn join_array_unchecked<const N: usize, const DIM: usize>( array: [StaticRc<T, N, DEN>; DIM], ) -> Self
where (): Sized, ((), ()): Sized,

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);
Source§

impl<const NUM: usize, const DEN: usize> StaticRc<dyn Any, NUM, DEN>

Source

pub fn downcast<T: Any>(self) -> Result<StaticRc<T, NUM, DEN>, Self>

Attempts to downcast Self to a concrete type.

Trait Implementations§

Source§

impl<T: ?Sized, const N: usize> AsMut<T> for StaticRc<T, N, N>

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, const NUM: usize, const DEN: usize> AsRef<T> for StaticRc<T, NUM, DEN>

Source§

fn as_ref(&self) -> &T

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

impl<T: ?Sized, const NUM: usize, const DEN: usize> Borrow<T> for StaticRc<T, NUM, DEN>

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T: ?Sized, const N: usize> BorrowMut<T> for StaticRc<T, N, N>

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T: ?Sized + Debug, const NUM: usize, const DEN: usize> Debug for StaticRc<T, NUM, DEN>

Source§

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

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

impl<T: Default, const N: usize> Default for StaticRc<T, N, N>
where (): Sized,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: ?Sized, const NUM: usize, const DEN: usize> Deref for StaticRc<T, NUM, DEN>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T: ?Sized, const N: usize> DerefMut for StaticRc<T, N, N>

Source§

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

Mutably dereferences the value.
Source§

impl<T: ?Sized + Display, const NUM: usize, const DEN: usize> Display for StaticRc<T, NUM, DEN>

Source§

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

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

impl<I: DoubleEndedIterator + ?Sized, const N: usize> DoubleEndedIterator for StaticRc<I, N, N>

Source§

fn next_back(&mut self) -> Option<I::Item>

Removes and returns an element from the end of the iterator. Read more
Source§

fn nth_back(&mut self, n: usize) -> Option<I::Item>

Returns the nth element from the end of the iterator. Read more
Source§

fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator from the back by n elements. Read more
1.27.0 · Source§

fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R
where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

This is the reverse version of Iterator::try_fold(): it takes elements starting from the back of the iterator. Read more
1.27.0 · Source§

fn rfold<B, F>(self, init: B, f: F) -> B
where Self: Sized, F: FnMut(B, Self::Item) -> B,

An iterator method that reduces the iterator’s elements to a single, final value, starting from the back. Read more
1.27.0 · Source§

fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator from the back that satisfies a predicate. Read more
Source§

impl<T: ?Sized, const NUM: usize, const DEN: usize> Drop for StaticRc<T, NUM, DEN>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<I: ExactSizeIterator + ?Sized, const N: usize> ExactSizeIterator for StaticRc<I, N, N>

Source§

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more
Source§

fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (exact_size_is_empty)
Returns true if the iterator is empty. Read more
Source§

impl<T: Copy, const N: usize> From<&[T]> for StaticRc<[T], N, N>

Source§

fn from(value: &[T]) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize> From<&str> for StaticRc<str, N, N>

Source§

fn from(value: &str) -> Self

Converts to this type from the input type.
Source§

impl<T, const LEN: usize, const N: usize> From<[T; LEN]> for StaticRc<[T], N, N>

Source§

fn from(value: [T; LEN]) -> Self

Converts to this type from the input type.
Source§

impl<T: ?Sized, const N: usize> From<Box<T>> for StaticRc<T, N, N>

Source§

fn from(value: Box<T>) -> Self

Converts to this type from the input type.
Source§

impl<T: Copy, const N: usize> From<Cow<'_, [T]>> for StaticRc<[T], N, N>

Source§

fn from(value: Cow<'_, [T]>) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize> From<Cow<'_, str>> for StaticRc<str, N, N>

Source§

fn from(value: Cow<'_, str>) -> Self

Converts to this type from the input type.
Source§

impl<T, const N: usize> From<StaticRc<[T], N, N>> for Vec<T>

Source§

fn from(value: StaticRc<[T], N, N>) -> Self

Converts to this type from the input type.
Source§

impl<T: ?Sized, const N: usize> From<StaticRc<T, N, N>> for Arc<T>

Source§

fn from(value: StaticRc<T, N, N>) -> Self

Converts to this type from the input type.
Source§

impl<T: ?Sized, const N: usize> From<StaticRc<T, N, N>> for Rc<T>

Source§

fn from(value: StaticRc<T, N, N>) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize> From<StaticRc<str, N, N>> for String

Source§

fn from(value: StaticRc<str, N, N>) -> Self

Converts to this type from the input type.
Source§

impl<const NUM: usize, const DEN: usize> From<StaticRc<str, NUM, DEN>> for StaticRc<[u8], NUM, DEN>

Source§

fn from(value: StaticRc<str, NUM, DEN>) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize> From<String> for StaticRc<str, N, N>

Source§

fn from(value: String) -> Self

Converts to this type from the input type.
Source§

impl<T, const N: usize> From<T> for StaticRc<T, N, N>

Source§

fn from(value: T) -> Self

Converts to this type from the input type.
Source§

impl<T, const N: usize> From<Vec<T>> for StaticRc<[T], N, N>

Source§

fn from(value: Vec<T>) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize> FromIterator<StaticRc<str, N, N>> for String

Source§

fn from_iter<I: IntoIterator<Item = StaticRc<str, N, N>>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl<T, const N: usize> FromIterator<T> for StaticRc<[T], N, N>

Source§

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl<F: ?Sized + Future + Unpin, const N: usize> Future for StaticRc<F, N, N>

Source§

type Output = <F as Future>::Output

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
Source§

impl<T: ?Sized + Hash, const NUM: usize, const DEN: usize> Hash for StaticRc<T, NUM, DEN>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<I: Iterator + ?Sized, const N: usize> Iterator for StaticRc<I, N, N>

Source§

type Item = <I as Iterator>::Item

The type of the elements being iterated over.
Source§

fn next(&mut self) -> Option<I::Item>

Advances the iterator and returns the next value. Read more
Source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
Source§

fn nth(&mut self, n: usize) -> Option<I::Item>

Returns the nth element of the iterator. Read more
Source§

fn last(self) -> Option<I::Item>

Consumes the iterator, returning the last element. Read more
Source§

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)
Advances the iterator and returns an array containing the next N values. Read more
1.0.0 · Source§

fn count(self) -> usize
where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more
Source§

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator by n elements. Read more
1.28.0 · Source§

fn step_by(self, step: usize) -> StepBy<Self>
where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
1.0.0 · Source§

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more
1.0.0 · Source§

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs. Read more
Source§

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places a copy of separator between adjacent items of the original iterator. Read more
Source§

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more
1.0.0 · Source§

fn map<B, F>(self, f: F) -> Map<Self, F>
where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element. Read more
1.21.0 · Source§

fn for_each<F>(self, f: F)
where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator. Read more
1.0.0 · Source§

fn filter<P>(self, predicate: P) -> Filter<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded. Read more
1.0.0 · Source§

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps. Read more
1.0.0 · Source§

fn enumerate(self) -> Enumerate<Self>
where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value. Read more
1.0.0 · Source§

fn peekable(self) -> Peekable<Self>
where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more
1.0.0 · Source§

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate. Read more
1.0.0 · Source§

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate. Read more
1.57.0 · Source§

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps. Read more
1.0.0 · Source§

fn skip(self, n: usize) -> Skip<Self>
where Self: Sized,

Creates an iterator that skips the first n elements. Read more
1.0.0 · Source§

fn take(self, n: usize) -> Take<Self>
where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more
1.0.0 · Source§

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator. Read more
1.0.0 · Source§

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure. Read more
1.29.0 · Source§

fn flatten(self) -> Flatten<Self>
where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure. Read more
Source§

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)
Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well. Read more
1.0.0 · Source§

fn fuse(self) -> Fuse<Self>
where Self: Sized,

Creates an iterator which ends after the first None. Read more
1.0.0 · Source§

fn inspect<F>(self, f: F) -> Inspect<Self, F>
where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Borrows an iterator, rather than consuming it. Read more
1.0.0 · Source§

fn collect<B>(self) -> B
where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection. Read more
Source§

fn try_collect<B>( &mut self, ) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType
where Self: Sized, Self::Item: Try, <Self::Item as Try>::Residual: Residual<B>, B: FromIterator<<Self::Item as Try>::Output>,

🔬This is a nightly-only experimental API. (iterator_try_collect)
Fallibly transforms an iterator into a collection, short circuiting if a failure is encountered. Read more
Source§

fn collect_into<E>(self, collection: &mut E) -> &mut E
where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)
Collects all the items from an iterator into a collection. Read more
1.0.0 · Source§

fn partition<B, F>(self, f: F) -> (B, B)
where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it. Read more
Source§

fn partition_in_place<'a, T, P>(self, predicate: P) -> usize
where T: 'a, Self: Sized + DoubleEndedIterator<Item = &'a mut T>, P: FnMut(&T) -> bool,

🔬This is a nightly-only experimental API. (iter_partition_in_place)
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
Source§

fn is_partitioned<P>(self, predicate: P) -> bool
where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)
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
1.27.0 · Source§

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
1.27.0 · Source§

fn try_for_each<F, R>(&mut self, f: F) -> R
where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

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
1.0.0 · Source§

fn fold<B, F>(self, init: B, f: F) -> B
where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result. Read more
1.51.0 · Source§

fn reduce<F>(self, f: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
Source§

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)
Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
1.0.0 · Source§

fn all<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate. Read more
1.0.0 · Source§

fn any<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate. Read more
1.0.0 · Source§

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate. Read more
1.30.0 · Source§

fn find_map<B, F>(&mut self, f: F) -> Option<B>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result. Read more
Source§

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
1.0.0 · Source§

fn position<P>(&mut self, predicate: P) -> Option<usize>
where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index. Read more
1.0.0 · Source§

fn rposition<P>(&mut self, predicate: P) -> Option<usize>
where P: FnMut(Self::Item) -> bool, Self: Sized + ExactSizeIterator + DoubleEndedIterator,

Searches for an element in an iterator from the right, returning its index. Read more
1.0.0 · Source§

fn max(self) -> Option<Self::Item>
where Self: Sized, Self::Item: Ord,

Returns the maximum element of an iterator. Read more
1.0.0 · Source§

fn min(self) -> Option<Self::Item>
where Self: Sized, Self::Item: Ord,

Returns the minimum element of an iterator. Read more
1.6.0 · Source§

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function. Read more
1.15.0 · Source§

fn max_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function. Read more
1.6.0 · Source§

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function. Read more
1.15.0 · Source§

fn min_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function. Read more
1.0.0 · Source§

fn rev(self) -> Rev<Self>
where Self: Sized + DoubleEndedIterator,

Reverses an iterator’s direction. Read more
1.0.0 · Source§

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers. Read more
1.36.0 · Source§

fn copied<'a, T>(self) -> Copied<Self>
where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements. Read more
1.0.0 · Source§

fn cloned<'a, T>(self) -> Cloned<Self>
where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements. Read more
Source§

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)
Returns an iterator over N elements of the iterator at a time. Read more
1.11.0 · Source§

fn sum<S>(self) -> S
where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator. Read more
1.11.0 · Source§

fn product<P>(self) -> P
where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements Read more
1.5.0 · Source§

fn cmp<I>(self, other: I) -> Ordering
where I: IntoIterator<Item = Self::Item>, Self::Item: Ord, Self: Sized,

Lexicographically compares the elements of this Iterator with those of another. Read more
Source§

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (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 · Source§

fn partial_cmp<I>(self, other: I) -> Option<Ordering>
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned. Read more
Source§

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (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 · Source§

fn eq<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another. Read more
Source§

fn eq_by<I, F>(self, other: I, eq: F) -> bool
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)
Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function. Read more
1.5.0 · Source§

fn ne<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another. Read more
1.5.0 · Source§

fn lt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another. Read more
1.5.0 · Source§

fn le<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more
1.5.0 · Source§

fn gt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more
1.5.0 · Source§

fn ge<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more
1.82.0 · Source§

fn is_sorted(self) -> bool
where Self: Sized, Self::Item: PartialOrd,

Checks if the elements of this iterator are sorted. Read more
1.82.0 · Source§

fn is_sorted_by<F>(self, compare: F) -> bool
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function. Read more
1.82.0 · Source§

fn is_sorted_by_key<F, K>(self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function. Read more
Source§

impl<T: ?Sized + Ord, const NUM: usize, const DEN: usize> Ord for StaticRc<T, NUM, DEN>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T, const NUM: usize, const DEN: usize, const N: usize, const D: usize> PartialEq<StaticRc<T, N, D>> for StaticRc<T, NUM, DEN>
where T: ?Sized + PartialEq<T>,

Source§

fn eq(&self, other: &StaticRc<T, N, D>) -> bool

Tests for self and other values to be equal, and is used by ==.
Source§

fn ne(&self, other: &StaticRc<T, N, D>) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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>,

Source§

fn partial_cmp(&self, other: &StaticRc<T, N, D>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
Source§

fn lt(&self, other: &StaticRc<T, N, D>) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
Source§

fn le(&self, other: &StaticRc<T, N, D>) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
Source§

fn gt(&self, other: &StaticRc<T, N, D>) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
Source§

fn ge(&self, other: &StaticRc<T, N, D>) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: ?Sized, const NUM: usize, const DEN: usize> Pointer for StaticRc<T, NUM, DEN>

Source§

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

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

impl<T: ?Sized + Eq, const NUM: usize, const DEN: usize> Eq for StaticRc<T, NUM, DEN>

Source§

impl<I: FusedIterator + ?Sized, const N: usize> FusedIterator for StaticRc<I, N, N>

Source§

impl<T: ?Sized + Send, const NUM: usize, const DEN: usize> Send for StaticRc<T, NUM, DEN>

Source§

impl<T: ?Sized + Sync, const NUM: usize, const DEN: usize> Sync for StaticRc<T, NUM, DEN>

Source§

impl<T: ?Sized, const NUM: usize, const DEN: usize> Unpin for StaticRc<T, NUM, DEN>

Auto Trait Implementations§

§

impl<T, const NUM: usize, const DEN: usize> Freeze for StaticRc<T, NUM, DEN>
where T: ?Sized,

§

impl<T, const NUM: usize, const DEN: usize> RefUnwindSafe for StaticRc<T, NUM, DEN>
where T: RefUnwindSafe + ?Sized,

§

impl<T, const NUM: usize, const DEN: usize> UnwindSafe for StaticRc<T, NUM, DEN>
where T: RefUnwindSafe + ?Sized,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

impl<I> IntoIterator for I
where I: Iterator,

Source§

type Item = <I as Iterator>::Item

The type of the elements being iterated over.
Source§

type IntoIter = I

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> I

Creates an iterator from a value. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.