Struct LinkList 

pub struct LinkList<T> {
    pub nodes: VecDeque<T>,
    pub flags: u32,
}

A doubly-ended list, port of struct linklist (Src/zsh.h:563). flags carries LF_ARRAY and friends from Src/subst.c:33.

Fields

nodes: VecDeque<T>

flags: u32

Implementations

impl<T> LinkList<T>

pub fn new() -> Self

Port of znewlinklist() from Src/linklist.c:116 — heap-arena fresh empty list. Rust uses LinkList::new().

pub fn is_empty(&self) -> bool

Port of the C macro empty(list) (Src/zsh.h:583) — firstnode(list) == NULL.

pub fn len(&self) -> usize

Port of countlinknodes(LinkList list) from Src/linklist.c:304.

pub fn push_front(&mut self, data: T)

Push at the head. Port of the C macro pushnode() (Src/zsh.h).

pub fn push_back(&mut self, data: T)

Push at the tail. Port of addlinknode() (Src/zsh.h) / zaddlinknode() (Src/linklist.c:151).

pub fn pop_front(&mut self) -> Option<T>

Pop the head. Port of getlinknode(LinkList list) (Src/linklist.c:210).

pub fn pop_back(&mut self) -> Option<T>

Pop the tail. Port of remnode(list, lastnode(list)) idiom.

pub fn front(&self) -> Option<&T>

Front-element ref, equivalent to firstnode(list)->dat (Src/zsh.h:576,586).

pub fn front_mut(&mut self) -> Option<&mut T>

front_mut — see implementation.

pub fn back(&self) -> Option<&T>

Back-element ref, equivalent to lastnode(list)->dat (Src/zsh.h:577,586).

pub fn back_mut(&mut self) -> Option<&mut T>

back_mut — see implementation.

pub fn iter(&self) -> Iter<'_, T>

iter — see implementation.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

iter_mut — see implementation.

pub fn append(&mut self, other: &mut LinkList<T>)

Append other onto the tail; drains other. Port of joinlists() (Src/linklist.c:360).

pub fn clear(&mut self)

Drop every node. Port of freelinklist(list, NULL) (Src/linklist.c:287).

pub fn to_vec(self) -> Vec<T>

where T: Clone,

to_vec — see implementation.

pub fn firstnode(&self) -> Option<usize>

Port of firstnode(X) macro (Src/zsh.h:576) — head node handle. Rust uses usize indices since the VecDeque backing gives O(1) random access matching C’s pointer walk.

pub fn lastnode(&self) -> Option<usize>

Port of lastnode(X) macro (Src/zsh.h:577).

pub fn nextnode(&self, idx: usize) -> Option<usize>

Port of nextnode(X) macro (Src/zsh.h:588).

pub fn prevnode(&self, idx: usize) -> Option<usize>

Port of prevnode(X) macro (Src/zsh.h:589).

pub fn getdata(&self, idx: usize) -> Option<&T>

Port of getdata(X) macro (Src/zsh.h:586).

pub fn setdata(&mut self, idx: usize, data: T)

Port of setdata(X,Y) macro (Src/zsh.h:587).

pub fn empty(&self) -> bool

Port of empty(X) macro (Src/zsh.h:583).

pub fn insertlinknode(&mut self, after_idx: usize, data: T) -> usize

Port of insertlinknode(list, after, dat) macro (Src/zsh.h:580) and the function form (Src/linklist.c:133) — insert after the supplied node index, return the index of the inserted node. WARNING: param names don’t match C — Rust=(after_idx, data) vs C=(list, node, dat)

pub fn delete_node(&mut self, idx: usize) -> Option<T>

Remove + free a node. Port of remnode(LinkList list, LinkNode nd) (Src/linklist.c:251).

pub fn insert_at(&mut self, idx: usize, data: T)

Port of pushlinknode(list, val) head-insert helper.

Trait Implementations

impl<T: Clone> Clone for LinkList<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LinkList<T>

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

Formats the value using the given formatter.

impl<T> Default for LinkList<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> FromIterator<T> for LinkList<T>

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

Creates a value from an iterator.

impl<T> IntoIterator for LinkList<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.