encode

package

v1.1.14 Latest Latest Go to latest Published: Apr 2, 2024 License: Apache-2.0 Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/wfusion/gofusion

Links

Open Source Insights

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
type Codecable
- func From[T ~[]byte | ~string](src T) (c Codecable)
type EncodedType
- func ParseEncodedType(s any) EncodedType
type Streamable
- func NewCodecStream(opts ...utils.OptionExtender) Streamable

Constants ¶

View Source

const (
	RndSeed int64 = -6544809196299914340
)

Variables ¶

View Source

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

Source Files ¶

View all Source files

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