codec

Documentation

Index

• Constants
• Variables
• func Marshal(codecID byte, v interface{}) ([]byte, error)
• func ProtoMarshal(v interface{}) ([]byte, error)
• func ProtoUnmarshal(data []byte, v interface{}) error
• func Reg(codec Codec)
• func Unmarshal(codecID byte, data []byte, v interface{}) error
• type Codec
  • func Get(codecID byte) (Codec, error)
  • func GetByName(codecName string) (Codec, error)
• type FormCodec
  • func (FormCodec) ID() byte
  • func (FormCodec) Marshal(v interface{}) ([]byte, error)
  • func (FormCodec) Name() string
  • func (FormCodec) Unmarshal(data []byte, v interface{}) error
• type JSONCodec
  • func (JSONCodec) ID() byte
  • func (JSONCodec) Marshal(v interface{}) ([]byte, error)
  • func (JSONCodec) Name() string
  • func (JSONCodec) Unmarshal(data []byte, v interface{}) error
• type PbEmpty
  • func (*PbEmpty) Descriptor() ([]byte, []int)
  • func (*PbEmpty) ProtoMessage()
  • func (x *PbEmpty) ProtoReflect() protoreflect.Message
  • func (x *PbEmpty) Reset()
  • func (x *PbEmpty) String() string
• type PlainCodec
  • func (PlainCodec) ID() byte
  • func (PlainCodec) Marshal(v interface{}) ([]byte, error)
  • func (PlainCodec) Name() string
  • func (PlainCodec) Unmarshal(data []byte, v interface{}) error
• type ProtoCodec
  • func (ProtoCodec) ID() byte
  • func (ProtoCodec) Marshal(v interface{}) ([]byte, error)
  • func (ProtoCodec) Name() string
  • func (ProtoCodec) Unmarshal(data []byte, v interface{}) error
• type XMLCodec
  • func (XMLCodec) ID() byte
  • func (XMLCodec) Marshal(v interface{}) ([]byte, error)
  • func (XMLCodec) Name() string
  • func (XMLCodec) Unmarshal(data []byte, v interface{}) error

Constants

const (
	// NilCodecID 空的编解码器id.
	NilCodecID byte = 0
	// NilCodecName 空的编解码器名称.
	NilCodecName string = ""
)

const (
	NameForm = "form"
	IdForm   = 'f'
)

const (
	NameJson = "json"
	IdJson   = 'j'
)

const (
	NamePlain = "plain"
	IdPlain   = 's'
)

const (
	NameProtobuf = "protobuf"
	IdProtobuf   = 'p'
)

const (
	NameXml = "xml"
	IdXml   = 'x'
)

Variables

var File_empty_proto protoreflect.FileDescriptor

var (
	// PbEmptyStruct 如果需要编码nil 或者struct，则不能编码，使用空的
	PbEmptyStruct = new(PbEmpty)
)

Functions

func Marshal

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

Marshal 使用指定编解码器编码

func ProtoMarshal

func ProtoMarshal(v interface{}) ([]byte, error)

func ProtoUnmarshal

func ProtoUnmarshal(data []byte, v interface{}) error

func Reg

func Reg(codec Codec)

Reg 注册编解码器到容器

func Unmarshal

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

Unmarshal 使用指定编解码器解码

Types

type Codec

type Codec interface {
	ID() byte
	Name() string
	Marshal(interface{}) ([]byte, error)
	Unmarshal([]byte, interface{}) error
}

Codec 消息内容的编解码器

func Get

func Get(codecID byte) (Codec, error)

Get 通过编解码器的id获取编解码器对象

func GetByName

func GetByName(codecName string) (Codec, error)

GetByName 通过编解码器的名字获取编解码器对象

type FormCodec

type FormCodec struct{}

FormCodec url encode codec

func (FormCodec) ID

func (FormCodec) ID() byte

ID returns codec id.

func (FormCodec) Marshal

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

func (FormCodec) Name

func (FormCodec) Name() string

Name returns codec name.

func (FormCodec) Unmarshal

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

type JSONCodec

type JSONCodec struct{}

func (JSONCodec) ID

func (JSONCodec) ID() byte

func (JSONCodec) Marshal

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

func (JSONCodec) Name

func (JSONCodec) Name() string

func (JSONCodec) Unmarshal

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

type PbEmpty

type PbEmpty struct {
	// contains filtered or unexported fields
}

func (*PbEmpty) Descriptor

func (*PbEmpty) Descriptor() ([]byte, []int)

Deprecated: Use PbEmpty.ProtoReflect.Descriptor instead.

func (*PbEmpty) ProtoMessage

func (*PbEmpty) ProtoMessage()

func (*PbEmpty) ProtoReflect

func (x *PbEmpty) ProtoReflect() protoreflect.Message

func (*PbEmpty) Reset

func (x *PbEmpty) Reset()

func (*PbEmpty) String

func (x *PbEmpty) String() string

type PlainCodec

type PlainCodec struct{}

PlainCodec plain text codec

func (PlainCodec) ID

func (PlainCodec) ID() byte

ID returns codec id.

func (PlainCodec) Marshal

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

func (PlainCodec) Name

func (PlainCodec) Name() string

Name returns codec name.

func (PlainCodec) Unmarshal

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

type ProtoCodec

type ProtoCodec struct{}

func (ProtoCodec) ID

func (ProtoCodec) ID() byte

func (ProtoCodec) Marshal

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

Marshal 编码

func (ProtoCodec) Name

func (ProtoCodec) Name() string

func (ProtoCodec) Unmarshal

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

Unmarshal 解码

type XMLCodec

type XMLCodec struct{}

func (XMLCodec) ID

func (XMLCodec) ID() byte

ID returns codec id.

func (XMLCodec) Marshal

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

func (XMLCodec) Name

func (XMLCodec) Name() string

Name returns codec name.

func (XMLCodec) Unmarshal

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