secret

Documentation

Overview

Package secret provides a custom string type that hides sensitive data from output.

Index

• type String
  • func (s String) MarshalJSON() ([]byte, error)
  • func (s String) SecretValue() string
  • func (s String) String() string
  • func (s *String) UnmarshalJSON(b []byte) error

Types

type String

type String string

String represents a string holding sensitive data.

func (String) MarshalJSON

func (s String) MarshalJSON() ([]byte, error)

MarshalJSON ensures the sensitive string is redacted in JSON.

func (String) SecretValue

func (s String) SecretValue() string

SecretValue returns the secret value.

func (String) String

func (s String) String() string

String implements the fmt.Stringer interface to prevent sensitive data from being printed.

func (*String) UnmarshalJSON

func (s *String) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals a secret value from JSON.