predicate

README

Documentation

Index

• Variables
• type BoolMatch
  • func (b BoolMatch) OK() bool
• type Match
• type P
  • func (p P[T]) Or(ps ...P[T]) P[T]
• type PR
  • func (p PR[T]) And(ps ...PR[T]) PR[T]
  • func (p PR[T]) BoolFunc() P[T]
  • func (p PR[T]) Filter(s []T) []T
  • func (p PR[T]) FilterCopy(s []T) []T
  • func (p PR[T]) Or(ps ...PR[T]) PR[T]

Variables

var (
	// Predefined Match values for common cases.
	True  = BoolMatch(true)
	False = BoolMatch(false)
)

Types

type BoolMatch

type BoolMatch bool

BoolMatch is a simple Match implementation based on a boolean value.

func (BoolMatch) OK

func (b BoolMatch) OK() bool

type Match

type Match interface {
	OK() bool
}

Match represents the result of a predicate evaluation.

type P

type P[T any] func(T) bool

P is a predicate function that tests whether a value of type T satisfies some condition.

func (P[T]) Or

func (p P[T]) Or(ps ...P[T]) P[T]

Or returns a predicate that is a short-circuiting logical OR of this and the given predicates. Note that P[T] only supports Or. For chained AND/OR logic, use PR[T].

type PR

type PR[T any] func(T) Match

PR is a predicate function that tests whether a value of type T satisfies some condition and returns a Match result.

func (PR[T]) And

func (p PR[T]) And(ps ...PR[T]) PR[T]

And returns a predicate that is a short-circuiting logical AND of this and the given predicates.

func (PR[T]) BoolFunc

func (p PR[T]) BoolFunc() P[T]

BoolFunc returns a P[T] version of this predicate.

func (PR[T]) Filter

func (p PR[T]) Filter(s []T) []T

Filter returns a new slice holding only the elements of s that satisfy p. Filter modifies the contents of the slice s and returns the modified slice, which may have a smaller length.

func (PR[T]) FilterCopy

func (p PR[T]) FilterCopy(s []T) []T

FilterCopy returns a new slice holding only the elements of s that satisfy p.

func (PR[T]) Or

func (p PR[T]) Or(ps ...PR[T]) PR[T]

Or returns a predicate that is a short-circuiting logical OR of this and the given predicates.