codec

package module

v0.0.14 Latest Latest Go to latest Published: Oct 15, 2024 License: MIT Imports: 12 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/origadmin/toolkits

Links

Open Source Insights

Documentation ¶

Overview ¶

Package codec is the codec package for encoding and decoding

Package codec is the codec package for encoding and decoding ¶

Package codec is the codec package for encoding and decoding

Index ¶

Constants
func Decode(rd io.Reader, obj any, ext string) error
func DecodeFromFile(name string, obj any) error
func DecodeJSONFile(name string, obj any) error
func DecodeTOMLFile(name string, obj any) error
func DecodeYAMLFile(name string, obj any) error
func Encode(w io.Writer, obj any, st Type) error
func EncodeJSONFile(name string, obj any) error
func EncodeTOMLFile(name string, obj any) error
func EncodeToFile(name string, obj any) error
func EncodeYAMLFile(name string, obj any) error
type Decoder
type Encoder
type Type
- func TypeFromExt(ext string) Type
- func TypeFromString(s string) Type

Constants ¶

View Source

const (
	ErrUnsupportedDecodeType = errors.String("codec: unsupported decode type")
)

View Source

const (
	ErrUnsupportedEncodeType = errors.String("codec: unsupported encode type")
)

Variables ¶

This section is empty.

Functions ¶

func Decode ¶ added in v0.0.5

func Decode(rd io.Reader, obj any, ext string) error

Decode Decodes the given reader with ext name into obj

func DecodeFromFile ¶ added in v0.0.13

func DecodeFromFile(name string, obj any) error

DecodeFromFile Decodes the given file

func DecodeJSONFile ¶

func DecodeJSONFile(name string, obj any) error

DecodeJSONFile Decodes the given JSON file

func DecodeTOMLFile ¶

func DecodeTOMLFile(name string, obj any) error

DecodeTOMLFile Decodes the given TOML file

func DecodeYAMLFile ¶

func DecodeYAMLFile(name string, obj any) error

DecodeYAMLFile Decodes the given YAML file

func Encode ¶ added in v0.0.5

func Encode(w io.Writer, obj any, st Type) error

func EncodeJSONFile ¶

func EncodeJSONFile(name string, obj any) error

EncodeJSONFile Encodes the given JSON file

func EncodeTOMLFile ¶

func EncodeTOMLFile(name string, obj any) error

EncodeTOMLFile Encodes the given TOML file

func EncodeToFile ¶ added in v0.0.13

func EncodeToFile(name string, obj any) error

EncodeToFile Encodes the given file

func EncodeYAMLFile ¶

func EncodeYAMLFile(name string, obj any) error

EncodeYAMLFile Encodes the given YAML file

Types ¶

type Decoder ¶ added in v0.0.5

type Decoder interface {
	Decode(any) error
}

Decoder interface

type Encoder ¶ added in v0.0.5

type Encoder interface {
	Encode(obj any) error
}

Encoder interface

type Type ¶ added in v0.0.5

type Type int

const (
	JSON    Type = iota // json
	YAML                // yaml
	TOML                // toml
	UNKNOWN             // unknown
)

func TypeFromExt ¶ added in v0.0.13

func TypeFromExt(ext string) Type

TypeFromExt returns the codec type from the file extension.

func TypeFromString ¶ added in v0.0.13

func TypeFromString(s string) Type

TypeFromString returns the codec type from the string.

func (Type) Exts ¶ added in v0.0.5

func (s Type) Exts() []string

func (Type) IsSupported ¶ added in v0.0.13

func (s Type) IsSupported() bool

func (Type) Marshal ¶ added in v0.0.12

func (s Type) Marshal(v interface{}) ([]byte, error)

func (Type) Name ¶ added in v0.0.12

func (s Type) Name() string

func (Type) NewDecoder ¶ added in v0.0.5

func (s Type) NewDecoder(r io.Reader) Decoder

func (Type) NewEncoder ¶ added in v0.0.5

func (s Type) NewEncoder(w io.Writer) Encoder

func (Type) String ¶ added in v0.0.5

func (i Type) String() string

func (Type) Unmarshal ¶ added in v0.0.12

func (s Type) Unmarshal(data []byte, v interface{}) error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
json Package json provides the json functions based on standard library	Package json provides the json functions based on standard library
toml Package toml provides the toml functions	Package toml provides the toml functions
yaml Package yaml provides the yaml functions	Package yaml provides the yaml functions

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