Struct gclient::ext::sp_core::bounded::alloc::collections::BinaryHeap
1.0.0 · source · pub struct BinaryHeap<T, A = Global>where
A: Allocator,{ /* private fields */ }
Expand description
A priority queue implemented with a binary heap.
This will be a max-heap.
It is a logic error for an item to be modified in such a way that the
item’s ordering relative to any other item, as determined by the Ord
trait, changes while it is in the heap. This is normally only possible
through interior mutability, global state, I/O, or unsafe code. The
behavior resulting from such a logic error is not specified, but will
be encapsulated to the BinaryHeap
that observed the logic error and not
result in undefined behavior. This could include panics, incorrect results,
aborts, memory leaks, and non-termination.
As long as no elements change their relative order while being in the heap
as described above, the API of BinaryHeap
guarantees that the heap
invariant remains intact i.e. its methods all behave as documented. For
example if a method is documented as iterating in sorted order, that’s
guaranteed to work as long as elements in the heap have not changed order,
even in the presence of closures getting unwinded out of, iterators getting
leaked, and similar foolishness.
§Examples
use std::collections::BinaryHeap;
// Type inference lets us omit an explicit type signature (which
// would be `BinaryHeap<i32>` in this example).
let mut heap = BinaryHeap::new();
// We can use peek to look at the next item in the heap. In this case,
// there's no items in there yet so we get None.
assert_eq!(heap.peek(), None);
// Let's add some scores...
heap.push(1);
heap.push(5);
heap.push(2);
// Now peek shows the most important item in the heap.
assert_eq!(heap.peek(), Some(&5));
// We can check the length of a heap.
assert_eq!(heap.len(), 3);
// We can iterate over the items in the heap, although they are returned in
// a random order.
for x in &heap {
println!("{x}");
}
// If we instead pop these scores, they should come back in order.
assert_eq!(heap.pop(), Some(5));
assert_eq!(heap.pop(), Some(2));
assert_eq!(heap.pop(), Some(1));
assert_eq!(heap.pop(), None);
// We can clear the heap of any remaining items.
heap.clear();
// The heap should now be empty.
assert!(heap.is_empty())
A BinaryHeap
with a known list of items can be initialized from an array:
use std::collections::BinaryHeap;
let heap = BinaryHeap::from([1, 5, 2]);
§Min-heap
Either core::cmp::Reverse
or a custom Ord
implementation can be used to
make BinaryHeap
a min-heap. This makes heap.pop()
return the smallest
value instead of the greatest one.
use std::collections::BinaryHeap;
use std::cmp::Reverse;
let mut heap = BinaryHeap::new();
// Wrap values in `Reverse`
heap.push(Reverse(1));
heap.push(Reverse(5));
heap.push(Reverse(2));
// If we pop these scores now, they should come back in the reverse order.
assert_eq!(heap.pop(), Some(Reverse(1)));
assert_eq!(heap.pop(), Some(Reverse(2)));
assert_eq!(heap.pop(), Some(Reverse(5)));
assert_eq!(heap.pop(), None);
§Time complexity
The value for push
is an expected cost; the method documentation gives a
more detailed analysis.
Implementations§
source§impl<T> BinaryHeap<T>where
T: Ord,
impl<T> BinaryHeap<T>where
T: Ord,
1.0.0 (const: 1.80.0) · sourcepub const fn new() -> BinaryHeap<T>
pub const fn new() -> BinaryHeap<T>
Creates an empty BinaryHeap
as a max-heap.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new();
heap.push(4);
1.0.0 · sourcepub fn with_capacity(capacity: usize) -> BinaryHeap<T>
pub fn with_capacity(capacity: usize) -> BinaryHeap<T>
Creates an empty BinaryHeap
with at least the specified capacity.
The binary heap will be able to hold at least capacity
elements without
reallocating. This method is allowed to allocate for more elements than
capacity
. If capacity
is 0, the binary heap will not allocate.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::with_capacity(10);
heap.push(4);
source§impl<T, A> BinaryHeap<T, A>
impl<T, A> BinaryHeap<T, A>
sourcepub const fn new_in(alloc: A) -> BinaryHeap<T, A>
🔬This is a nightly-only experimental API. (allocator_api
)
pub const fn new_in(alloc: A) -> BinaryHeap<T, A>
allocator_api
)Creates an empty BinaryHeap
as a max-heap, using A
as allocator.
§Examples
Basic usage:
#![feature(allocator_api)]
use std::alloc::System;
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new_in(System);
heap.push(4);
sourcepub fn with_capacity_in(capacity: usize, alloc: A) -> BinaryHeap<T, A>
🔬This is a nightly-only experimental API. (allocator_api
)
pub fn with_capacity_in(capacity: usize, alloc: A) -> BinaryHeap<T, A>
allocator_api
)Creates an empty BinaryHeap
with at least the specified capacity, using A
as allocator.
The binary heap will be able to hold at least capacity
elements without
reallocating. This method is allowed to allocate for more elements than
capacity
. If capacity
is 0, the binary heap will not allocate.
§Examples
Basic usage:
#![feature(allocator_api)]
use std::alloc::System;
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::with_capacity_in(10, System);
heap.push(4);
1.12.0 · sourcepub fn peek_mut(&mut self) -> Option<PeekMut<'_, T, A>>
pub fn peek_mut(&mut self) -> Option<PeekMut<'_, T, A>>
Returns a mutable reference to the greatest item in the binary heap, or
None
if it is empty.
Note: If the PeekMut
value is leaked, some heap elements might get
leaked along with it, but the remaining elements will remain a valid
heap.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new();
assert!(heap.peek_mut().is_none());
heap.push(1);
heap.push(5);
heap.push(2);
{
let mut val = heap.peek_mut().unwrap();
*val = 0;
}
assert_eq!(heap.peek(), Some(&2));
§Time complexity
If the item is modified then the worst case time complexity is O(log(n)), otherwise it’s O(1).
1.0.0 · sourcepub fn pop(&mut self) -> Option<T>
pub fn pop(&mut self) -> Option<T>
Removes the greatest item from the binary heap and returns it, or None
if it
is empty.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::from([1, 3]);
assert_eq!(heap.pop(), Some(3));
assert_eq!(heap.pop(), Some(1));
assert_eq!(heap.pop(), None);
§Time complexity
The worst case cost of pop
on a heap containing n elements is O(log(n)).
1.0.0 · sourcepub fn push(&mut self, item: T)
pub fn push(&mut self, item: T)
Pushes an item onto the binary heap.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new();
heap.push(3);
heap.push(5);
heap.push(1);
assert_eq!(heap.len(), 3);
assert_eq!(heap.peek(), Some(&5));
§Time complexity
The expected cost of push
, averaged over every possible ordering of
the elements being pushed, and over a sufficiently large number of
pushes, is O(1). This is the most meaningful cost metric when pushing
elements that are not already in any sorted pattern.
The time complexity degrades if elements are pushed in predominantly ascending order. In the worst case, elements are pushed in ascending sorted order and the amortized cost per push is O(log(n)) against a heap containing n elements.
The worst case cost of a single call to push
is O(n). The worst case
occurs when capacity is exhausted and needs a resize. The resize cost
has been amortized in the previous figures.
1.5.0 · sourcepub fn into_sorted_vec(self) -> Vec<T, A>
pub fn into_sorted_vec(self) -> Vec<T, A>
Consumes the BinaryHeap
and returns a vector in sorted
(ascending) order.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::from([1, 2, 4, 5, 7]);
heap.push(6);
heap.push(3);
let vec = heap.into_sorted_vec();
assert_eq!(vec, [1, 2, 3, 4, 5, 6, 7]);
1.11.0 · sourcepub fn append(&mut self, other: &mut BinaryHeap<T, A>)
pub fn append(&mut self, other: &mut BinaryHeap<T, A>)
Moves all the elements of other
into self
, leaving other
empty.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut a = BinaryHeap::from([-10, 1, 2, 3, 3]);
let mut b = BinaryHeap::from([-20, 5, 43]);
a.append(&mut b);
assert_eq!(a.into_sorted_vec(), [-20, -10, 1, 2, 3, 3, 5, 43]);
assert!(b.is_empty());
sourcepub fn drain_sorted(&mut self) -> DrainSorted<'_, T, A> ⓘ
🔬This is a nightly-only experimental API. (binary_heap_drain_sorted
)
pub fn drain_sorted(&mut self) -> DrainSorted<'_, T, A> ⓘ
binary_heap_drain_sorted
)Clears the binary heap, returning an iterator over the removed elements in heap order. If the iterator is dropped before being fully consumed, it drops the remaining elements in heap order.
The returned iterator keeps a mutable borrow on the heap to optimize its implementation.
Note:
.drain_sorted()
is O(n * log(n)); much slower than.drain()
. You should use the latter for most cases.
§Examples
Basic usage:
#![feature(binary_heap_drain_sorted)]
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::from([1, 2, 3, 4, 5]);
assert_eq!(heap.len(), 5);
drop(heap.drain_sorted()); // removes all elements in heap order
assert_eq!(heap.len(), 0);
1.70.0 · sourcepub fn retain<F>(&mut self, f: F)
pub fn retain<F>(&mut self, f: F)
Retains only the elements specified by the predicate.
In other words, remove all elements e
for which f(&e)
returns
false
. The elements are visited in unsorted (and unspecified) order.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::from([-10, -5, 1, 2, 4, 13]);
heap.retain(|x| x % 2 == 0); // only keep even numbers
assert_eq!(heap.into_sorted_vec(), [-10, 2, 4])
source§impl<T, A> BinaryHeap<T, A>where
A: Allocator,
impl<T, A> BinaryHeap<T, A>where
A: Allocator,
1.0.0 · sourcepub fn iter(&self) -> Iter<'_, T> ⓘ
pub fn iter(&self) -> Iter<'_, T> ⓘ
Returns an iterator visiting all values in the underlying vector, in arbitrary order.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let heap = BinaryHeap::from([1, 2, 3, 4]);
// Print 1, 2, 3, 4 in arbitrary order
for x in heap.iter() {
println!("{x}");
}
sourcepub fn into_iter_sorted(self) -> IntoIterSorted<T, A> ⓘ
🔬This is a nightly-only experimental API. (binary_heap_into_iter_sorted
)
pub fn into_iter_sorted(self) -> IntoIterSorted<T, A> ⓘ
binary_heap_into_iter_sorted
)Returns an iterator which retrieves elements in heap order.
This method consumes the original heap.
§Examples
Basic usage:
#![feature(binary_heap_into_iter_sorted)]
use std::collections::BinaryHeap;
let heap = BinaryHeap::from([1, 2, 3, 4, 5]);
assert_eq!(heap.into_iter_sorted().take(2).collect::<Vec<_>>(), [5, 4]);
1.0.0 · sourcepub fn peek(&self) -> Option<&T>
pub fn peek(&self) -> Option<&T>
Returns the greatest item in the binary heap, or None
if it is empty.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new();
assert_eq!(heap.peek(), None);
heap.push(1);
heap.push(5);
heap.push(2);
assert_eq!(heap.peek(), Some(&5));
§Time complexity
Cost is O(1) in the worst case.
1.0.0 · sourcepub fn capacity(&self) -> usize
pub fn capacity(&self) -> usize
Returns the number of elements the binary heap can hold without reallocating.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::with_capacity(100);
assert!(heap.capacity() >= 100);
heap.push(4);
1.0.0 · sourcepub fn reserve_exact(&mut self, additional: usize)
pub fn reserve_exact(&mut self, additional: usize)
Reserves the minimum capacity for at least additional
elements more than
the current length. Unlike reserve
, this will not
deliberately over-allocate to speculatively avoid frequent allocations.
After calling reserve_exact
, capacity will be greater than or equal to
self.len() + additional
. Does nothing if the capacity is already
sufficient.
§Panics
Panics if the new capacity overflows usize
.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new();
heap.reserve_exact(100);
assert!(heap.capacity() >= 100);
heap.push(4);
1.0.0 · sourcepub fn reserve(&mut self, additional: usize)
pub fn reserve(&mut self, additional: usize)
Reserves capacity for at least additional
elements more than the
current length. The allocator may reserve more space to speculatively
avoid frequent allocations. After calling reserve
,
capacity will be greater than or equal to self.len() + additional
.
Does nothing if capacity is already sufficient.
§Panics
Panics if the new capacity overflows usize
.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new();
heap.reserve(100);
assert!(heap.capacity() >= 100);
heap.push(4);
1.63.0 · sourcepub fn try_reserve_exact(
&mut self,
additional: usize,
) -> Result<(), TryReserveError>
pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>
Tries to reserve the minimum capacity for at least additional
elements
more than the current length. Unlike try_reserve
, this will not
deliberately over-allocate to speculatively avoid frequent allocations.
After calling try_reserve_exact
, capacity will be greater than or
equal to self.len() + additional
if it returns Ok(())
.
Does nothing if the capacity is already sufficient.
Note that the allocator may give the collection more space than it
requests. Therefore, capacity can not be relied upon to be precisely
minimal. Prefer try_reserve
if future insertions are expected.
§Errors
If the capacity overflows, or the allocator reports a failure, then an error is returned.
§Examples
use std::collections::BinaryHeap;
use std::collections::TryReserveError;
fn find_max_slow(data: &[u32]) -> Result<Option<u32>, TryReserveError> {
let mut heap = BinaryHeap::new();
// Pre-reserve the memory, exiting if we can't
heap.try_reserve_exact(data.len())?;
// Now we know this can't OOM in the middle of our complex work
heap.extend(data.iter());
Ok(heap.pop())
}
1.63.0 · sourcepub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>
pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>
Tries to reserve capacity for at least additional
elements more than the
current length. The allocator may reserve more space to speculatively
avoid frequent allocations. After calling try_reserve
, capacity will be
greater than or equal to self.len() + additional
if it returns
Ok(())
. Does nothing if capacity is already sufficient. This method
preserves the contents even if an error occurs.
§Errors
If the capacity overflows, or the allocator reports a failure, then an error is returned.
§Examples
use std::collections::BinaryHeap;
use std::collections::TryReserveError;
fn find_max_slow(data: &[u32]) -> Result<Option<u32>, TryReserveError> {
let mut heap = BinaryHeap::new();
// Pre-reserve the memory, exiting if we can't
heap.try_reserve(data.len())?;
// Now we know this can't OOM in the middle of our complex work
heap.extend(data.iter());
Ok(heap.pop())
}
1.0.0 · sourcepub fn shrink_to_fit(&mut self)
pub fn shrink_to_fit(&mut self)
Discards as much additional capacity as possible.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap: BinaryHeap<i32> = BinaryHeap::with_capacity(100);
assert!(heap.capacity() >= 100);
heap.shrink_to_fit();
assert!(heap.capacity() == 0);
1.56.0 · sourcepub fn shrink_to(&mut self, min_capacity: usize)
pub fn shrink_to(&mut self, min_capacity: usize)
Discards capacity with a lower bound.
The capacity will remain at least as large as both the length and the supplied value.
If the current capacity is less than the lower limit, this is a no-op.
§Examples
use std::collections::BinaryHeap;
let mut heap: BinaryHeap<i32> = BinaryHeap::with_capacity(100);
assert!(heap.capacity() >= 100);
heap.shrink_to(10);
assert!(heap.capacity() >= 10);
1.80.0 · sourcepub fn as_slice(&self) -> &[T]
pub fn as_slice(&self) -> &[T]
Returns a slice of all values in the underlying vector, in arbitrary order.
§Examples
Basic usage:
use std::collections::BinaryHeap;
use std::io::{self, Write};
let heap = BinaryHeap::from([1, 2, 3, 4, 5, 6, 7]);
io::sink().write(heap.as_slice()).unwrap();
1.5.0 · sourcepub fn into_vec(self) -> Vec<T, A>
pub fn into_vec(self) -> Vec<T, A>
Consumes the BinaryHeap
and returns the underlying vector
in arbitrary order.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let heap = BinaryHeap::from([1, 2, 3, 4, 5, 6, 7]);
let vec = heap.into_vec();
// Will print in some order
for x in vec {
println!("{x}");
}
sourcepub fn allocator(&self) -> &A
🔬This is a nightly-only experimental API. (allocator_api
)
pub fn allocator(&self) -> &A
allocator_api
)Returns a reference to the underlying allocator.
1.0.0 · sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the length of the binary heap.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let heap = BinaryHeap::from([1, 3]);
assert_eq!(heap.len(), 2);
1.0.0 · sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Checks if the binary heap is empty.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::new();
assert!(heap.is_empty());
heap.push(3);
heap.push(5);
heap.push(1);
assert!(!heap.is_empty());
1.6.0 · sourcepub fn drain(&mut self) -> Drain<'_, T, A> ⓘ
pub fn drain(&mut self) -> Drain<'_, T, A> ⓘ
Clears the binary heap, returning an iterator over the removed elements in arbitrary order. If the iterator is dropped before being fully consumed, it drops the remaining elements in arbitrary order.
The returned iterator keeps a mutable borrow on the heap to optimize its implementation.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let mut heap = BinaryHeap::from([1, 3]);
assert!(!heap.is_empty());
for x in heap.drain() {
println!("{x}");
}
assert!(heap.is_empty());
Trait Implementations§
1.0.0 · source§impl<T, A> Clone for BinaryHeap<T, A>
impl<T, A> Clone for BinaryHeap<T, A>
source§fn clone_from(&mut self, source: &BinaryHeap<T, A>)
fn clone_from(&mut self, source: &BinaryHeap<T, A>)
Overwrites the contents of self
with a clone of the contents of source
.
This method is preferred over simply assigning source.clone()
to self
,
as it avoids reallocation if possible.
See Vec::clone_from()
for more details.
source§fn clone(&self) -> BinaryHeap<T, A>
fn clone(&self) -> BinaryHeap<T, A>
1.4.0 · source§impl<T, A> Debug for BinaryHeap<T, A>
impl<T, A> Debug for BinaryHeap<T, A>
§impl<T> Decode for BinaryHeap<T>
impl<T> Decode for BinaryHeap<T>
§fn decode<I>(input: &mut I) -> Result<BinaryHeap<T>, Error>where
I: Input,
fn decode<I>(input: &mut I) -> Result<BinaryHeap<T>, Error>where
I: Input,
§fn decode_into<I>(
input: &mut I,
dst: &mut MaybeUninit<Self>,
) -> Result<DecodeFinished, Error>where
I: Input,
fn decode_into<I>(
input: &mut I,
dst: &mut MaybeUninit<Self>,
) -> Result<DecodeFinished, Error>where
I: Input,
§fn skip<I>(input: &mut I) -> Result<(), Error>where
I: Input,
fn skip<I>(input: &mut I) -> Result<(), Error>where
I: Input,
§fn encoded_fixed_size() -> Option<usize>
fn encoded_fixed_size() -> Option<usize>
§impl<T> DecodeLength for BinaryHeap<T>
impl<T> DecodeLength for BinaryHeap<T>
1.0.0 · source§impl<T> Default for BinaryHeap<T>where
T: Ord,
impl<T> Default for BinaryHeap<T>where
T: Ord,
source§fn default() -> BinaryHeap<T>
fn default() -> BinaryHeap<T>
Creates an empty BinaryHeap<T>
.
source§impl<'de, T> Deserialize<'de> for BinaryHeap<T>where
T: Deserialize<'de> + Ord,
impl<'de, T> Deserialize<'de> for BinaryHeap<T>where
T: Deserialize<'de> + Ord,
source§fn deserialize<D>(
deserializer: D,
) -> Result<BinaryHeap<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<BinaryHeap<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
§impl<T> Encode for BinaryHeap<T>where
T: Encode,
impl<T> Encode for BinaryHeap<T>where
T: Encode,
§fn using_encoded<R, F>(&self, f: F) -> R
fn using_encoded<R, F>(&self, f: F) -> R
§fn encoded_size(&self) -> usize
fn encoded_size(&self) -> usize
§impl<V> EncodeAsType for BinaryHeap<V>where
V: EncodeAsType,
impl<V> EncodeAsType for BinaryHeap<V>where
V: EncodeAsType,
§fn encode_as_type_to<R>(
&self,
type_id: <R as TypeResolver>::TypeId,
types: &R,
out: &mut Vec<u8>,
) -> Result<(), Error>where
R: TypeResolver,
fn encode_as_type_to<R>(
&self,
type_id: <R as TypeResolver>::TypeId,
types: &R,
out: &mut Vec<u8>,
) -> Result<(), Error>where
R: TypeResolver,
type_id
, types
, a context
and some output target for the SCALE encoded bytes,
attempt to SCALE encode the current value into the type given by type_id
.1.2.0 · source§impl<'a, T, A> Extend<&'a T> for BinaryHeap<T, A>
impl<'a, T, A> Extend<&'a T> for BinaryHeap<T, A>
source§fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = &'a T>,
fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = &'a T>,
source§fn extend_one(&mut self, _: &'a T)
fn extend_one(&mut self, _: &'a T)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)1.0.0 · source§impl<T, A> Extend<T> for BinaryHeap<T, A>
impl<T, A> Extend<T> for BinaryHeap<T, A>
source§fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = T>,
fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = T>,
source§fn extend_one(&mut self, item: T)
fn extend_one(&mut self, item: T)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)1.56.0 · source§impl<T, const N: usize> From<[T; N]> for BinaryHeap<T>where
T: Ord,
impl<T, const N: usize> From<[T; N]> for BinaryHeap<T>where
T: Ord,
source§fn from(arr: [T; N]) -> BinaryHeap<T>
fn from(arr: [T; N]) -> BinaryHeap<T>
use std::collections::BinaryHeap;
let mut h1 = BinaryHeap::from([1, 4, 2, 3]);
let mut h2: BinaryHeap<_> = [1, 4, 2, 3].into();
while let Some((a, b)) = h1.pop().zip(h2.pop()) {
assert_eq!(a, b);
}
1.5.0 · source§impl<T, A> From<BinaryHeap<T, A>> for Vec<T, A>where
A: Allocator,
impl<T, A> From<BinaryHeap<T, A>> for Vec<T, A>where
A: Allocator,
source§fn from(heap: BinaryHeap<T, A>) -> Vec<T, A>
fn from(heap: BinaryHeap<T, A>) -> Vec<T, A>
Converts a BinaryHeap<T>
into a Vec<T>
.
This conversion requires no data movement or allocation, and has constant time complexity.
1.5.0 · source§impl<T, A> From<Vec<T, A>> for BinaryHeap<T, A>
impl<T, A> From<Vec<T, A>> for BinaryHeap<T, A>
source§fn from(vec: Vec<T, A>) -> BinaryHeap<T, A>
fn from(vec: Vec<T, A>) -> BinaryHeap<T, A>
Converts a Vec<T>
into a BinaryHeap<T>
.
This conversion happens in-place, and has O(n) time complexity.
1.0.0 · source§impl<T> FromIterator<T> for BinaryHeap<T>where
T: Ord,
impl<T> FromIterator<T> for BinaryHeap<T>where
T: Ord,
source§fn from_iter<I>(iter: I) -> BinaryHeap<T>where
I: IntoIterator<Item = T>,
fn from_iter<I>(iter: I) -> BinaryHeap<T>where
I: IntoIterator<Item = T>,
1.0.0 · source§impl<'a, T, A> IntoIterator for &'a BinaryHeap<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a BinaryHeap<T, A>where
A: Allocator,
1.0.0 · source§impl<T, A> IntoIterator for BinaryHeap<T, A>where
A: Allocator,
impl<T, A> IntoIterator for BinaryHeap<T, A>where
A: Allocator,
source§fn into_iter(self) -> IntoIter<T, A> ⓘ
fn into_iter(self) -> IntoIter<T, A> ⓘ
Creates a consuming iterator, that is, one that moves each value out of the binary heap in arbitrary order. The binary heap cannot be used after calling this.
§Examples
Basic usage:
use std::collections::BinaryHeap;
let heap = BinaryHeap::from([1, 2, 3, 4]);
// Print 1, 2, 3, 4 in arbitrary order
for x in heap.into_iter() {
// x has type i32, not &i32
println!("{x}");
}
§impl<T> IntoVisitor for BinaryHeap<T>where
T: IntoVisitor + Ord,
impl<T> IntoVisitor for BinaryHeap<T>where
T: IntoVisitor + Ord,
§type AnyVisitor<R: TypeResolver> = BasicVisitor<BinaryHeap<T>, R>
type AnyVisitor<R: TypeResolver> = BasicVisitor<BinaryHeap<T>, R>
Self
.§fn into_visitor<R>() -> <BinaryHeap<T> as IntoVisitor>::AnyVisitor<R>where
R: TypeResolver,
fn into_visitor<R>() -> <BinaryHeap<T> as IntoVisitor>::AnyVisitor<R>where
R: TypeResolver,
source§impl<T> Serialize for BinaryHeap<T>where
T: Serialize,
impl<T> Serialize for BinaryHeap<T>where
T: Serialize,
source§fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S,
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
§impl<T> TypeInfo for BinaryHeap<T>where
T: TypeInfo + 'static,
impl<T> TypeInfo for BinaryHeap<T>where
T: TypeInfo + 'static,
impl<T, LikeT> EncodeLike<&[(LikeT,)]> for BinaryHeap<T>where
T: EncodeLike<LikeT>,
LikeT: Encode,
impl<T, LikeT> EncodeLike<BinaryHeap<LikeT>> for &[(T,)]where
T: EncodeLike<LikeT>,
LikeT: Encode,
impl<T, LikeT> EncodeLike<BinaryHeap<LikeT>> for BinaryHeap<T>where
T: EncodeLike<LikeT>,
LikeT: Encode,
Auto Trait Implementations§
impl<T, A> Freeze for BinaryHeap<T, A>where
A: Freeze,
impl<T, A> RefUnwindSafe for BinaryHeap<T, A>where
A: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, A> Send for BinaryHeap<T, A>
impl<T, A> Sync for BinaryHeap<T, A>
impl<T, A> Unpin for BinaryHeap<T, A>
impl<T, A> UnwindSafe for BinaryHeap<T, A>where
A: UnwindSafe,
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
§fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
§fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> DecodeAsType for Twhere
T: IntoVisitor,
impl<T> DecodeAsType for Twhere
T: IntoVisitor,
fn decode_as_type_maybe_compact<R>(
input: &mut &[u8],
type_id: <R as TypeResolver>::TypeId,
types: &R,
is_compact: bool,
) -> Result<T, Error>where
R: TypeResolver,
§fn decode_as_type<R>(
input: &mut &[u8],
type_id: <R as TypeResolver>::TypeId,
types: &R,
) -> Result<Self, Error>where
R: TypeResolver,
fn decode_as_type<R>(
input: &mut &[u8],
type_id: <R as TypeResolver>::TypeId,
types: &R,
) -> Result<Self, Error>where
R: TypeResolver,
type_id
, and type registry, attempt to decode said bytes into
Self
. Implementations should modify the &mut
reference to the bytes such that any bytes
not used in the course of decoding are still pointed to after decoding is complete.§impl<T> DecodeLimit for Twhere
T: Decode,
impl<T> DecodeLimit for Twhere
T: Decode,
§impl<T> DecodeWithMetadata for Twhere
T: DecodeAsType,
impl<T> DecodeWithMetadata for Twhere
T: DecodeAsType,
§fn decode_with_metadata(
bytes: &mut &[u8],
type_id: u32,
metadata: &Metadata,
) -> Result<T, Error>
fn decode_with_metadata( bytes: &mut &[u8], type_id: u32, metadata: &Metadata, ) -> Result<T, Error>
Self
.§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> EncodeWithMetadata for Twhere
T: EncodeAsType,
impl<T> EncodeWithMetadata for Twhere
T: EncodeAsType,
source§impl<I> EventProcessor for I
impl<I> EventProcessor for I
source§fn not_waited() -> Error
fn not_waited() -> Error
source§fn proc<'life0, 'async_trait, T>(
&'life0 mut self,
predicate: impl Fn(RuntimeEvent) -> Option<T> + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
I: 'async_trait,
fn proc<'life0, 'async_trait, T>(
&'life0 mut self,
predicate: impl Fn(RuntimeEvent) -> Option<T> + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
I: 'async_trait,
source§fn proc_many<'life0, 'async_trait, T>(
&'life0 mut self,
predicate: impl Fn(RuntimeEvent) -> Option<T> + 'async_trait,
validate: impl Fn(Vec<T>) -> (Vec<T>, bool) + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<Vec<T>, Error>> + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
I: 'async_trait,
fn proc_many<'life0, 'async_trait, T>(
&'life0 mut self,
predicate: impl Fn(RuntimeEvent) -> Option<T> + 'async_trait,
validate: impl Fn(Vec<T>) -> (Vec<T>, bool) + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<Vec<T>, Error>> + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
I: 'async_trait,
source§fn message_processed<'life0, 'async_trait>(
&'life0 mut self,
message_id: MessageId,
) -> Pin<Box<dyn Future<Output = Result<DispatchStatus>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn message_processed<'life0, 'async_trait>(
&'life0 mut self,
message_id: MessageId,
) -> Pin<Box<dyn Future<Output = Result<DispatchStatus>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
message_id
has been processed.source§fn message_processed_batch<'life0, 'async_trait>(
&'life0 mut self,
message_ids: impl 'async_trait + IntoIterator<Item = MessageId>,
) -> Pin<Box<dyn Future<Output = Result<Vec<(MessageId, DispatchStatus)>>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn message_processed_batch<'life0, 'async_trait>(
&'life0 mut self,
message_ids: impl 'async_trait + IntoIterator<Item = MessageId>,
) -> Pin<Box<dyn Future<Output = Result<Vec<(MessageId, DispatchStatus)>>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
message_ids
has been processed.source§fn reply_bytes_on<'life0, 'async_trait>(
&'life0 mut self,
message_id: MessageId,
) -> Pin<Box<dyn Future<Output = Result<(MessageId, Result<Vec<u8>, String>, u128)>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn reply_bytes_on<'life0, 'async_trait>(
&'life0 mut self,
message_id: MessageId,
) -> Pin<Box<dyn Future<Output = Result<(MessageId, Result<Vec<u8>, String>, u128)>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
message_id
. Read moresource§fn err_or_succeed<'life0, 'async_trait>(
&'life0 mut self,
message_id: MessageId,
) -> Pin<Box<dyn Future<Output = Result<Option<String>>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn err_or_succeed<'life0, 'async_trait>(
&'life0 mut self,
message_id: MessageId,
) -> Pin<Box<dyn Future<Output = Result<Option<String>>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
message_id
resulted in an error or has been successful. Read moresource§fn err_or_succeed_batch<'life0, 'async_trait>(
&'life0 mut self,
message_ids: impl 'async_trait + IntoIterator<Item = MessageId>,
) -> Pin<Box<dyn Future<Output = Result<Vec<(MessageId, Option<String>)>>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn err_or_succeed_batch<'life0, 'async_trait>(
&'life0 mut self,
message_ids: impl 'async_trait + IntoIterator<Item = MessageId>,
) -> Pin<Box<dyn Future<Output = Result<Vec<(MessageId, Option<String>)>>> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
message_ids
resulted in errors or has been successful. Read more§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FromBits<T> for T
impl<T> FromBits<T> for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
T
. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.