incognigo

package module

Go to main page

Versions in this module

v0

v0.3.0

Jul 29, 2026

Changes in this version

type Engine

+ func (e *Engine) ContainsPII(ctx context.Context, input []byte) (bool, error)

v0.2.0

Jul 29, 2026

Changes in this version

+ type ConfidenceBand uint8

+ const ConfidenceLikely

+ const ConfidencePossible

+ const ConfidenceStrong

+ const ConfidenceUnspecified

+ const ConfidenceWeak

+ func (confidence ConfidenceBand) Valid() bool

type DetectorRegistration

+ AlgorithmVersion string

+ DefaultConfidence ConfidenceBand

+ Evidence EvidenceFlags

+ Locale string

type Engine

+ func (e *Engine) Inspect(ctx context.Context, input []byte) ([]Finding, error)

type Error

+ func (e *Error) Is(target error) bool

+ type EvidenceFlags uint16

+ const EvidenceBoundary

+ const EvidenceChecksum

+ const EvidenceContext

+ const EvidenceDictionary

+ const EvidenceModel

+ const EvidenceScheme

+ const EvidenceShape

+ func (evidence EvidenceFlags) Valid() bool

+ type Finding struct

+ AlgorithmVersion string

+ Confidence ConfidenceBand

+ DetectorID DetectorID

+ Evidence EvidenceFlags

+ Locale string

+ MinimumConfidence ConfidenceBand

+ Outcome FindingOutcome

+ Span Span

+ Type PIIType

+ type FindingOutcome uint8

+ const FindingBelowThreshold

+ const FindingOutcomeUnknown

+ const FindingOverlapRejected

+ const FindingSelected

type Match

+ Confidence ConfidenceBand

+ Evidence EvidenceFlags

+ type MatchSink interface

+ Add func(Match) bool

type PIIType

+ const PIITypeGBNHSNumber

+ const PIITypeGBNINO

+ const PIITypeIBAN

+ const PIITypeMACAddress

+ const PIITypeUSABARouting

+ const PIITypeUSITIN

+ const PIITypeUSNPI

+ const PIITypeUSSSN

type Policy

+ MinimumConfidence ConfidenceBand

+ type SizedTransformer interface

+ TransformedSize func(piiType PIIType, valueBytes int) (int, error)

v0.1.0

Jul 27, 2026

Changes in this version

+ var ErrDetection = errors.New("incognigo: detection failed")

+ var ErrInvalidConfiguration = errors.New("incognigo: invalid configuration")

+ var ErrInvalidMatch = errors.New("incognigo: invalid detector match")

+ var ErrLimitExceeded = errors.New("incognigo: processing limit exceeded")

+ var ErrStreamRead = errors.New("incognigo: stream read failed")

+ var ErrStreamWrite = errors.New("incognigo: stream write failed")

+ var ErrTransformation = errors.New("incognigo: transformation failed")

+ type Config struct

+ Detectors []DetectorRegistration

+ Limits ProcessingLimits

+ Policies []Policy

+ type Detector interface

+ Detect func(ctx context.Context, input []byte) ([]Match, error)

+ type DetectorBounds struct

+ LookaheadBytes int

+ LookbehindBytes int

+ MaxMatchBytes int

+ type DetectorID string

+ func (id DetectorID) Valid() bool

+ type DetectorRegistration struct

+ Bounds DetectorBounds

+ Detector Detector

+ ID DetectorID

+ Types []PIIType

+ type Determinism uint8

+ const Deterministic

+ const NonDeterministic

+ func (d Determinism) Valid() bool

+ type Engine struct

+ func NewEngine(config Config) (*Engine, error)

+ func (e *Engine) Limits() ProcessingLimits

+ func (e *Engine) ProtectBytes(ctx context.Context, input []byte) ([]byte, error)

+ func (e *Engine) ProtectStream(ctx context.Context, destination io.Writer, source io.Reader) (int64, error)

+ func (e *Engine) ProtectString(ctx context.Context, input string) (string, error)

+ type Error struct

+ func (e *Error) Counts() (actual int, maximum int, ok bool)

+ func (e *Error) DetectorID() DetectorID

+ func (e *Error) Error() string

+ func (e *Error) Field() string

+ func (e *Error) Kind() ErrorKind

+ func (e *Error) Limit() string

+ func (e *Error) Operation() string

+ func (e *Error) PIIType() PIIType

+ func (e *Error) Unwrap() error

+ type ErrorKind uint8

+ const ErrorKindDetection

+ const ErrorKindInvalidConfiguration

+ const ErrorKindInvalidMatch

+ const ErrorKindLimitExceeded

+ const ErrorKindStreamRead

+ const ErrorKindStreamWrite

+ const ErrorKindTransformation

+ const ErrorKindUnknown

+ type Match struct

+ Span Span

+ Type PIIType

+ func (m Match) Valid(inputBytes int) bool

+ type PIIType string

+ const PIITypeEmailAddress

+ const PIITypeIPAddress

+ const PIITypePaymentCardNumber

+ const PIITypePhoneNumber

+ func (t PIIType) Valid() bool

+ type Policy struct

+ Determinism Determinism

+ Priority int

+ Transformer Transformer

+ Type PIIType

+ type ProcessingLimits struct

+ MaxBatchInputBytes int

+ MaxBatchMatches int

+ MaxBatchOutputBytes int

+ MaxStreamBufferBytes int

+ func DefaultProcessingLimits() ProcessingLimits

+ type Span struct

+ End int

+ Start int

+ func (s Span) Valid(inputBytes int) bool

+ type Transformer interface

+ Transform func(ctx context.Context, piiType PIIType, value []byte) ([]byte, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL