encode

Documentation

Index

• Constants
• Variables
• func Cipher(algo cipher.Algorithm, mode cipher.Mode, key, iv []byte) utils.OptionFunc[option]
• func Compress(algo compress.Algorithm) utils.OptionFunc[option]
• func Encode(algo Algorithm) utils.OptionFunc[option]
• func NewDecodeFunc(algo Algorithm) func([]byte) ([]byte, error)
• func NewEncodeFunc(algo Algorithm) func([]byte) ([]byte, error)
• func NewReader(algo Algorithm, r io.Reader) io.Reader
• func NewWriter(algo Algorithm, w io.Writer) io.Writer
• type Algorithm
  • func ParseAlgorithm(s any) Algorithm
  • func (e Algorithm) IsValid() bool
  • func (e Algorithm) String() string
  • func (e Algorithm) Value() uint8
• type Codecable
  • func From[T ~[]byte | ~string](src T) (c Codecable)
• type EncodedType
  • func ParseEncodedType(s any) EncodedType
  • func (e EncodedType) IsValid() bool
  • func (e EncodedType) String() string
  • func (e EncodedType) Value() uint8
• type Streamable
  • func NewCodecStream(opts ...utils.OptionExtender) Streamable

Constants

const (
	RndSeed int64 = -6544809196299914340
)

Variables

var (
	ErrUnknownAlgorithm     = errors.New("unknown encode algorithm")
	ErrEncodeMethodNotFound = errors.New("not found encode method")
)

Functions

func Cipher

func Cipher(algo cipher.Algorithm, mode cipher.Mode, key, iv []byte) utils.OptionFunc[option]

func Compress

func Compress(algo compress.Algorithm) utils.OptionFunc[option]

func Encode

func Encode(algo Algorithm) utils.OptionFunc[option]

func NewDecodeFunc

func NewDecodeFunc(algo Algorithm) func([]byte) ([]byte, error)

func NewEncodeFunc

func NewEncodeFunc(algo Algorithm) func([]byte) ([]byte, error)

func NewReader

func NewReader(algo Algorithm, r io.Reader) io.Reader

func NewWriter

func NewWriter(algo Algorithm, w io.Writer) io.Writer

Types

type Algorithm

type Algorithm uint8

const (
	AlgorithmUnknown Algorithm = iota
	AlgorithmHex
	AlgorithmBase32Std
	AlgorithmBase32Hex
	AlgorithmBase64Std
	AlgorithmBase64URL
	AlgorithmBase64RawStd // without padding
	AlgorithmBase64RawURL // without padding
)

func ParseAlgorithm

func ParseAlgorithm(s any) Algorithm

func (Algorithm) IsValid

func (e Algorithm) IsValid() bool

func (Algorithm) String

func (e Algorithm) String() string

func (Algorithm) Value

func (e Algorithm) Value() uint8

type Codecable

type Codecable interface {
	Encode(opts ...utils.OptionExtender) Codecable
	Decode(opts ...utils.OptionExtender) Codecable
	ToBytes() (dst []byte, err error)
	ToString() (dst string, err error)
}

func From

func From[T ~[]byte | ~string](src T) (c Codecable)

From a byte slice or a string, not concurrent safe

type EncodedType

type EncodedType int8

const (
	EncodedTypeUnknown EncodedType = iota
	EncodedTypeCipher
	EncodedTypeCompress
	EncodedTypeEncode
)

func ParseEncodedType

func ParseEncodedType(s any) EncodedType

func (EncodedType) IsValid

func (e EncodedType) IsValid() bool

func (EncodedType) String

func (e EncodedType) String() string

func (EncodedType) Value

func (e EncodedType) Value() uint8

type Streamable

type Streamable interface {
	Encode(dst io.Writer, src io.Reader) (n int64, err error)
	Decode(dst io.Writer, src io.Reader) (n int64, err error)
}

func NewCodecStream

func NewCodecStream(opts ...utils.OptionExtender) Streamable