keycheck

README

keycheck-go

A simple validator suitable for simple tasks inspired from OpenBullet's KeyCheck feature

Installation

Use go get -u command:

go get -u github.com/colduction/keycheck-go

Documentation

Index

• Constants
• type BitwiseID
  • func (bi BitwiseID) IsValid() bool
• type ID
• type KeyChain
  • func NewKeyChain[T any](condition BitwiseID) (KeyChain[T], error)

Constants

const (
	NOT BitwiseID = iota // Bitwise NOT
	AND                  // Bitwise AND
	OR                   // Bitwise OR
	XOR                  // Bitwise XOR (exclusive OR)

	SUCCESS ID = "SUCCESS"
	FAIL    ID = "FAIL"
	INVALID ID = "INVALID"
	CUSTOM  ID = "CUSTOM"
	RETRY   ID = "RETRY"
	BAN     ID = "BAN"
	NONE    ID = "NONE"
)

Types

type BitwiseID

type BitwiseID uint8 // Bitwise Operator ID

func (BitwiseID) IsValid

func (bi BitwiseID) IsValid() bool

IsValid checks if the BitwiseID is a defined operator.

type ID

type ID string

type KeyChain

type KeyChain[T any] interface {
	DelValidator(label ID) error
	GetValidator(label ID) (func(a T) (bool, error), error)
	Reset()
	SetCondition(condition BitwiseID) error
	SetValidator(label ID, fn func(a T) (bool, error)) error
	Validate(data T, defaultLabel ID) (ID, bool, []error)
}

func NewKeyChain

func NewKeyChain[T any](condition BitwiseID) (KeyChain[T], error)

NewKeyChain creates and returns a new KeyChain instance with a specified bitwise condition for validation logic. It returns an error if the condition is invalid.