Crate orx_linked_list

An actually useful linked list :) documentation will follow.

Example

use orx_linked_list::prelude::*;

let mut list = LinkedList::with_exponential_growth(2, 1.5);

// build linked list: x <-> a <-> b <-> c
list.push_back('a');
list.push_back('b');
list.push_front('x');
list.push_back('c');

assert_eq!(Some('c'), list.pop_back());
assert_eq!(Some('b'), list.pop_back());
assert_eq!(Some('a'), list.pop_back());
assert_eq!(Some('x'), list.pop_back());
assert_eq!(None, list.pop_back());
assert_eq!(None, list.pop_front());

Modules

• prelude
  Common traits, enums and structs.

Structs

• CustomGrowth
  Stategy which allows to define a custom growth rate with a function of priorly created fragments.
• DoublingGrowth
  Stategy which allows creates a fragment with double the capacity of the prior fragment every time the split vector needs to expand.
• ExponentialGrowth
  Stategy which allows new fragments grow exponentially.
• FixedVec
  A fixed vector, FixedVec, is a vector with a strict predetermined capacity (see SplitVec for dynamic capacity version).
• Fragment
  A contagious fragment of the split vector.
• ImpVec
  ImpVec stands for ‘immutable-push-vec’.
• ImpVecIter
  Iterator over the ImpVec.
• ImpVecIterMut
  Iterator over the ImpVec.
• LinearGrowth
  Stategy which allows the split vector to grow linearly.
• LinkedList
  The LinkedList allows pushing and popping elements at either end in constant time.
• MemoryStatus
  Utilization of the underlying vector of the linked list.
• SplitVec
  A split vector; i.e., a vector of fragments, with the following features:
• SplitVecIterator
  Iterator over the SplitVec.

Enums

• MemoryUtilization
  LinkedList holds all elements close to each other in a PinnedVec aiming for better cache locality while using thin references rather than wide pointers and to reduce heap allocations.
• SplitVecSlice
  Returns the result of trying to get a slice as a contagious memory from the split vector.

Traits

• NotSelfRefVecItem
  Marker trait for types to be contained in a PinnedVec which do not hold a field which is a reference to a another element of the same vector.
• PinnedVec
  A vector of elements of T which differs from the std::vec::Vec by the following feature:
• PinnedVecSimple
  PinnedVecSimple is a PinnedVec where the elements satisfy the trait bound `T: NotSelfRefVecItem.
• SelfRefVecItem
  A type to be contained in a PinnedVec which does hold a field which is a reference to a another element of the same vector.
• SplitVecGrowth
  Growth strategy of a split vector.