package genstack

Import Path
	github.com/jackc/puddle/v2/internal/genstack (on go.dev)

Dependency Relation
	imports 0 packages, and imported by one package

Involved Source Files

	    gen_stack.go
	    stack.go
Package-Level Type Names (total 2, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type GenStack[T] (struct)

		Type Parameters:
			T: any

		GenStack implements a generational stack.
		
		GenStack works as common stack except for the fact that all elements in the
		older generation are guaranteed to be popped before any element in the newer
		generation. New elements are always pushed to the current (newest)
		generation.
		
		We could also say that GenStack behaves as a stack in case of a single
		generation, but it behaves as a queue of individual generation stacks.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			new *stack[T]
			old *stack[T]
		Methods (total 4, all are exported)
			(*GenStack[T]) Len() int
				Len returns number of elements in the stack.

			(*GenStack[T]) NextGen()
				NextGen starts a new stack generation.

			(*GenStack[T]) Pop() (T, bool)
			(*GenStack[T]) Push(v T)
				Push pushes a new element at the top of the stack.

		As Outputs Of (at least one exported)
			func NewGenStack[T]() *GenStack[T]

	/* one unexported ... *//* one unexported: */
	 type stack[T] (struct)

		Type Parameters:
			T: any

		stack is a wrapper around an array implementing a stack.
		
		We cannot use slice to represent the stack because append might change the
		pointer value of the slice. That would be an issue in GenStack
		implementation.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			arr []T
		Methods (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*stack[T]) len() int
				len returns number of elements in the stack.

			(*stack[T]) pop() T
				pop pops the stack top-most element.
				
				If stack length is zero, this method panics.

			(*stack[T]) push(vs ...T)
				push pushes a new element at the top of a stack.

			(*stack[T]) takeAll() []T
				takeAll returns all elements in the stack in order as they are stored - i.e.
				the top-most stack element is the last one.



Package-Level Functions (only one, which is exported)

	 func NewGenStack[T]() *GenStack[T]

		Type Parameters:
			T: any

		NewGenStack creates a new empty GenStack.

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)