Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

masker

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 18, 2026

Changes in this version

+ const MaskTypeRedact

+ const RedactedValue

+ var ErrFrozen = errors.New("masker configuration is frozen")

+ var ErrInvalidOption = errors.New("invalid masker option")

+ func Float64(tag string, value float64) (float64, error)

+ func Int(tag string, value int) (int, error)

+ func MaskChar() string

+ func MaskRedact(_ string, value string) (string, error)

+ func MaskRedactAny(_ string, value any) (any, error)

+ func RegisterMaskAnyFunc(maskType string, maskFunc MaskAnyFunc)

+ func RegisterMaskField(fieldName, maskType string)

+ func RegisterMaskFloat64Func(maskType string, maskFunc MaskFloat64Func)

+ func RegisterMaskIntFunc(maskType string, maskFunc MaskIntFunc)

+ func RegisterMaskStringFunc(maskType string, maskFunc MaskStringFunc)

+ func RegisterMaskUintFunc(maskType string, maskFunc MaskUintFunc)

+ func SetMaskChar(s string)

+ func String(tag, value string) (string, error)

+ func Uint(tag string, value uint) (uint, error)

type Masker

+ func New(options ...Option) (*Masker, error)

+ func NewSecure(options ...Option) (*Masker, error)

+ func (m *Masker) Freeze() *Masker

+ func (m *Masker) Frozen() bool

+ type Option func(*config) error

+ func WithCache(enabled bool) Option

+ func WithMaskAnyFunc(maskType string, maskFunc MaskAnyFunc) Option

+ func WithMaskChar(char string) Option

+ func WithMaskField(fieldName, maskType string) Option

+ func WithMaskFloat64Func(maskType string, maskFunc MaskFloat64Func) Option

+ func WithMaskIntFunc(maskType string, maskFunc MaskIntFunc) Option

+ func WithMaskStringFunc(maskType string, maskFunc MaskStringFunc) Option

+ func WithMaskUintFunc(maskType string, maskFunc MaskUintFunc) Option

+ func WithProfile(profile Profile) Option

+ func WithTagName(name string) Option

+ type Profile string

+ const ProfileDefault

+ const ProfileNone

+ const ProfileSecure

v0.1.0

Mar 22, 2025

Changes in this version

+ const MaskTypePreserveEnds

+ func MaskPreserveEnds(arg string, value string) (string, error)

v0.0.1

Nov 24, 2024

Changes in this version

+ func Mask[T any](target T) (ret T, err error)

+ type MaskAnyFunc func(arg string, value any) (any, error)

+ type MaskFloat64Func func(arg string, value float64) (float64, error)

+ type MaskIntFunc func(arg string, value int) (int, error)

+ type MaskStringFunc func(arg string, value string) (string, error)

+ type MaskUintFunc func(arg string, value uint) (uint, error)

+ type Masker struct

+ var Default *Masker

+ func (m *Masker) Cache(enable bool)

+ func (m *Masker) Float64(tag string, value float64) (float64, error)

+ func (m *Masker) Int(tag string, value int) (int, error)

+ func (m *Masker) Mask(target any) (ret any, err error)

+ func (m *Masker) MaskChar() string

+ func (m *Masker) MaskFilledString(arg, value string) (string, error)

+ func (m *Masker) MaskFixedString(arg, value string) (string, error)

+ func (m *Masker) MaskHashString(arg, value string) (string, error)

+ func (m *Masker) MaskRandomFloat64(arg string, value float64) (float64, error)

+ func (m *Masker) MaskRandomInt(arg string, value int) (int, error)

+ func (m *Masker) MaskZero(arg string, value any) (any, error)

+ func (m *Masker) RegisterMaskAnyFunc(maskType string, maskFunc MaskAnyFunc)

+ func (m *Masker) RegisterMaskField(fieldName, maskType string)

+ func (m *Masker) RegisterMaskFloat64Func(maskType string, maskFunc MaskFloat64Func)

+ func (m *Masker) RegisterMaskIntFunc(maskType string, maskFunc MaskIntFunc)

+ func (m *Masker) RegisterMaskStringFunc(maskType string, maskFunc MaskStringFunc)

+ func (m *Masker) RegisterMaskUintFunc(maskType string, maskFunc MaskUintFunc)

+ func (m *Masker) SetMaskChar(s string)

+ func (m *Masker) SetTagName(s string)

+ func (m *Masker) String(tag, value string) (string, error)

+ func (m *Masker) Uint(tag string, value uint) (uint, error)