synclist

Documentation

Index

• type Iterator
  • func (it *Iterator[T]) Get() T
  • func (it *Iterator[T]) Move()
  • func (it *Iterator[T]) Valid() bool
• type List
  • func New[T any]() *List[T]
  • func NewFromIterable[T any](iterable iter.Iterable[T]) *List[T]
  • func (list *List[T]) Clear()
  • func (list *List[T]) Head() *Node[T]
  • func (list *List[T]) Iterator() iter.Iterator[T]
  • func (list *List[T]) Prepend(value T)
  • func (list *List[T]) Reverse()
  • func (list *List[T]) Stream(yield func(T) bool)
• type Node
  • func (node Node[T]) Next() *Node[T]

Types

type Iterator

type Iterator[T any] struct {
	// contains filtered or unexported fields
}

Iterator is an iterator over the elements in a List.

func (*Iterator[T]) Get

func (it *Iterator[T]) Get() T

Get returns the element at the current position.

func (*Iterator[T]) Move

func (it *Iterator[T]) Move()

Move moves the iterator to the next element.

func (*Iterator[T]) Valid

func (it *Iterator[T]) Valid() bool

Valid returns true if the iterator is positioned at a valid element.

type List

type List[T any] struct {
	// contains filtered or unexported fields
}

List is a lock-free singly linked list. It is safe to use it concurrently from multiple goroutines. The zero value is ready to use. Do not copy a non-zero List.

func New

func New[T any]() *List[T]

New creates an empty List.

func NewFromIterable

func NewFromIterable[T any](iterable iter.Iterable[T]) *List[T]

NewFromIterable creates a List from the specified iter.Iterable in reverse order. List.Reverse can be used to restore the original order.

func (*List[T]) Clear

func (list *List[T]) Clear()

Clear removes all elements from the List.

func (*List[T]) Head

func (list *List[T]) Head() *Node[T]

Head returns the first element in the List.

func (*List[T]) Iterator

func (list *List[T]) Iterator() iter.Iterator[T]

Iterator returns an iterator over the elements in the List.

func (*List[T]) Prepend

func (list *List[T]) Prepend(value T)

Prepend adds the specified value to the beginning of the List.

func (*List[T]) Reverse

func (list *List[T]) Reverse()

Reverse reverses the order of the elements in the List. This method is not thread-safe. It is meant to be used after all concurrent operations on the List have finished.

func (*List[T]) Stream

func (list *List[T]) Stream(yield func(T) bool)

Stream streams the elements of the List.

type Node

type Node[T any] struct {
	Value T // The value stored in the node.
	// contains filtered or unexported fields
}

Node is a node in a singly linked list.

func (Node[T]) Next

func (node Node[T]) Next() *Node[T]

Next returns the next node in the list.