container

Documentation

Overview

Package container provides OOP-style containers.

For better performance, all functions in this package and its subpackages are unsafe for concurrency unless otherwise specified.

Index

• type Container
• type Filter

Types

type Container

type Container[Item any] interface {
	// Len returns the number of items in the container.
	Len() int

	// Range accesses the items in the container.
	// Each item is accessed once.
	// The order of the access depends on the specific implementation.
	//
	// Its parameter handler is a function to deal with the item x in the
	// container and report whether to continue to access the next item.
	//
	// The client should do read-only operations on x
	// to avoid corrupting the container.
	Range(handler func(x Item) (cont bool))
}

Container is an interface representing a general container.

type Filter

type Filter[Item any] interface {
	// Filter refines items in the container.
	//
	// Its parameter filter is a function to report whether to keep the item x.
	Filter(filter func(x Item) (keep bool))
}

Filter wraps the method Filter that refines items in the container.

Its implementation should use an in-place refinement if possible.