Skip to main content

Children

Struct Children 

Source
pub struct Children<T>(/* private fields */);
Expand description

A node’s children in order, each under its order key.

Implementations§

Source§

impl<T> Children<T>

Source

pub fn new() -> Self

Source

pub fn from_vec(nodes: Vec<T>) -> Self

Children placed all at once, keys spread evenly.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn iter(&self) -> impl DoubleEndedIterator<Item = &T> + ExactSizeIterator

The children in order.

Source

pub fn iter_mut( &mut self, ) -> impl DoubleEndedIterator<Item = &mut T> + ExactSizeIterator

Source

pub fn entries(&self) -> impl DoubleEndedIterator<Item = (&OrderKey, &T)>

The children in order, with their keys.

Source

pub fn get(&self, key: &OrderKey) -> Option<&T>

Source

pub fn get_mut(&mut self, key: &OrderKey) -> Option<&mut T>

Source

pub fn nth(&self, at: usize) -> Option<&T>

The child at places from the first, counting each one before it: for tests, and for callers that hold a place, not a key.

Source

pub fn nth_mut(&mut self, at: usize) -> Option<&mut T>

The child at places from the first, to change.

Source

pub fn first_key(&self) -> Option<&OrderKey>

Source

pub fn last_key(&self) -> Option<&OrderKey>

Source

pub fn key_after(&self, key: &OrderKey) -> Option<&OrderKey>

The key of the child after the one under key, if any.

Source

pub fn key_before(&self, key: &OrderKey) -> Option<&OrderKey>

The key of the child before the one under key, if any.

Source

pub fn push(&mut self, t: T) -> OrderKey

Places t last, and returns its key.

Source

pub fn insert_after(&mut self, after: Option<&OrderKey>, t: T) -> OrderKey

Places t right after the child under after, or first when None, and returns its key.

Source

pub fn put(&mut self, key: OrderKey, t: T)

Places t under key, which no child has: where it was taken from.

Source

pub fn remove(&mut self, key: &OrderKey) -> Option<T>

Source

pub fn clear(&mut self)

Source

pub fn rank(&self, key: &OrderKey) -> usize

How many children come before the one under key: its place.

Trait Implementations§

Source§

impl<T: Clone> Clone for Children<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Children<T>

Source§

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

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

impl<T: Default> Default for Children<T>

Source§

fn default() -> Self

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

impl<T> FromIterator<T> for Children<T>

Source§

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

Creates a value from an iterator. Read more
Source§

impl<T> Index<usize> for Children<T>

Source§

type Output = T

The returned type after indexing.
Source§

fn index(&self, at: usize) -> &T

Performs the indexing (container[index]) operation. Read more
Source§

impl<'a, T> IntoIterator for &'a Children<T>

Source§

type Item = &'a T

The type of the elements being iterated over.
Source§

type IntoIter = Values<'a, OrderKey, T>

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

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<T: PartialEq> PartialEq for Children<T>

Two lists of children are the same when they hold the same nodes in the same order, whatever keys placed them.

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Children<T>

§

impl<T> RefUnwindSafe for Children<T>

§

impl<T> Send for Children<T>
where BTreeMap<OrderKey, T>: Send,

§

impl<T> Sync for Children<T>
where BTreeMap<OrderKey, T>: Sync,

§

impl<T> Unpin for Children<T>
where BTreeMap<OrderKey, T>: Unpin,

§

impl<T> UnsafeUnpin for Children<T>

§

impl<T> UnwindSafe for Children<T>

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> Brush for T
where T: Clone + PartialEq + Default + Debug,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.