masker

package module

Go to main page

Versions in this module

v0

v0.6.1

Sep 30, 2026

v0.6.0

Sep 30, 2026

Changes in this version

type Masker

+ func (m *Masker) MaskJSONValue(value any) (result []byte, err error)

v0.5.0

Sep 29, 2026

Changes in this version

type Option

+ func WithAWSKeyIDDetection() Option

+ func WithCardNumberDetection() Option

+ func WithoutEmbeddedDocuments() Option

+ func WithoutTextDetectors() Option

+ func WithoutValueInspection() Option

type Source

+ const SourceText

v0.4.0

Sep 29, 2026

v0.3.0

Sep 29, 2026

v0.2.0

Sep 29, 2026

Changes in this version

type Option

+ func WithTagRule(name string, rule Rule) Option

v0.1.1

Aug 28, 2026

v0.1.0

Aug 28, 2026

Changes in this version

+ const DefaultRedactionMarker

+ const DefaultStructTag

+ var ErrCycle = errors.New("masker: cycle detected")

+ var ErrDepthLimit = errors.New("masker: depth limit exceeded")

+ var ErrFieldConflict = errors.New("masker: field conflict")

+ var ErrInputLimit = errors.New("masker: input limit exceeded")

+ var ErrInvalidConfig = errors.New("masker: invalid configuration")

+ var ErrInvalidJSON = errors.New("masker: invalid JSON")

+ var ErrInvalidUTF8 = errors.New("masker: invalid UTF-8")

+ var ErrNodeLimit = errors.New("masker: node limit exceeded")

+ var ErrPanic = errors.New("masker: callback panic")

+ var ErrPolicyFailure = errors.New("masker: policy failure")

+ var ErrRuleFailure = errors.New("masker: rule failure")

+ var ErrUnsupportedKey = errors.New("masker: unsupported map key")

+ var ErrUnsupportedType = errors.New("masker: unsupported type")

+ type Binding struct

+ Keys []string

+ Rule Rule

+ func DefaultBindings() []Binding

+ type Decision struct

+ Omit bool

+ Rule Rule

+ type ErrorCode string

+ const CodeCycle

+ const CodeDepthLimit

+ const CodeFieldConflict

+ const CodeInputLimit

+ const CodeInvalidConfig

+ const CodeInvalidJSON

+ const CodeInvalidUTF8

+ const CodeNodeLimit

+ const CodePanic

+ const CodePolicyFailure

+ const CodeRuleFailure

+ const CodeUnsupportedKey

+ const CodeUnsupportedType

+ type Field struct

+ Key string

+ Kind ValueKind

+ Path string

+ Source Source

+ type KeyPolicy struct

+ func NewKeyPolicy(bindings ...Binding) (*KeyPolicy, error)

+ func (p *KeyPolicy) Decide(field Field) (Decision, error)

+ type MaskError struct

+ Code ErrorCode

+ ConflictingField string

+ Depth int

+ Field string

+ Operation string

+ Path string

+ Rule string

+ func (e *MaskError) Error() string

+ func (e *MaskError) Unwrap() error

+ type MaskErrors struct

+ Items []*MaskError

+ func (e *MaskErrors) Error() string

+ func (e *MaskErrors) Unwrap() []error

+ type Masker struct

+ func New(policy Policy, opts ...Option) (*Masker, error)

+ func (m *Masker) MaskAny(value any) (result any, err error)

+ func (m *Masker) MaskField(field Field, value any) (result any, err error)

+ func (m *Masker) MaskJSON(src []byte) (result []byte, err error)

+ func (m *Masker) MaskJSONReader(src io.Reader) (result []byte, err error)

+ func (m *Masker) MaskString(value string, rule Rule) (result string, err error)

+ func (m *Masker) MaskValue(key string, value any) (any, error)

+ type Option func(*config) error

+ func WithMaxDepth(depth int) Option

+ func WithMaxInputBytes(bytes int64) Option

+ func WithMaxNodes(nodes int) Option

+ func WithPreserveSafeTypes() Option

+ func WithRedaction(marker string) Option

+ func WithStructTag(name string) Option

+ type Policy interface

+ Decide func(Field) (Decision, error)

+ func Chain(policies ...Policy) Policy

+ func DefaultPolicy() Policy

+ type PolicyFunc func(Field) (Decision, error)

+ func (f PolicyFunc) Decide(field Field) (Decision, error)

+ type Rule interface

+ Apply func(RuleInput) (string, error)

+ Name func() string

+ func CardRule() Rule

+ func EmailRule() Rule

+ func FullRule() Rule

+ func IDRule() Rule

+ func NewRule(name string, fn RuleFunc) (Rule, error)

+ func PasswordRule() Rule

+ func PhoneRule() Rule

+ func TokenRule() Rule

+ type RuleFunc func(RuleInput) (string, error)

+ func (f RuleFunc) Apply(input RuleInput) (string, error)

+ func (f RuleFunc) Name() string

+ type RuleInput struct

+ Kind ValueKind

+ Redaction string

+ Value string

+ type Source uint8

+ const SourceAny

+ const SourceHeader

+ const SourceJSON

+ const SourceMap

+ const SourceStruct

+ const SourceURLFragment

+ const SourceURLQuery

+ const SourceURLUserInfo

+ const SourceUnknown

+ type ValueKind uint8

+ const KindArray

+ const KindBool

+ const KindInvalid

+ const KindNil

+ const KindNumber

+ const KindObject

+ const KindString

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