secret

Documentation

Index

• type Secret
  • func New[T any](secret T) Secret[T]
  • func (s Secret[T]) ExposeSecret() T
  • func (s Secret[T]) MarshalJSON() ([]byte, error)
  • func (s *Secret[T]) Scan(src any) error
  • func (s Secret[T]) String() string

Types

type Secret

type Secret[T any] struct {
	// contains filtered or unexported fields
}

Secret define a wrapper of T to prevent unwanted exposure of a secret (in logs for example).

func New

func New[T any](secret T) Secret[T]

New wrapps the given secret in Secret type and returns it.

func (Secret[T]) ExposeSecret

func (s Secret[T]) ExposeSecret() T

ExposeSecret returns the underlying secret. It is best practice to never store the secret and expose it only when needed.

func (Secret[T]) MarshalJSON

func (s Secret[T]) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*Secret[T]) Scan

func (s *Secret[T]) Scan(src any) error

Scan implements sql.Scanner.

func (Secret[T]) String

func (s Secret[T]) String() string

String implements fmt.Stringer.