codec

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 6, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package codec is the body's codec set.

Copyright 2015-2023 HenryLee. All Rights Reserved. Copyright 2024 sqos. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source 
const (
	// NilCodecID empty codec id.
	NilCodecID byte = 0
	// NilCodecName empty codec name.
	NilCodecName string = ""
)
View Source 
const (
	NAME_FORM = "form"
	ID_FORM   = 'f'
)

form(url encode) codec name and id

View Source 
const (
	NAME_JSON = "json"
	ID_JSON   = 'j'
)

json codec name and id

View Source 
const (
	NAME_PLAIN = "plain"
	ID_PLAIN   = 's'
)

plain text codec name and id

View Source 
const (
	NAME_PROTOBUF = "protobuf"
	ID_PROTOBUF   = 'p'
)

protobuf codec name and id

View Source 
const (
	NAME_THRIFT = "thrift"
	ID_THRIFT   = 't'
)

thrift codec name and id

View Source 
const (
	NAME_XML = "xml"
	ID_XML   = 'x'
)

xml codec name and id

Variables

View Source 
var File_empty_proto protoreflect.FileDescriptor
View Source 
var GoUnusedProtection__ int
View Source 
var (
	// PbEmptyStruct empty struct for protobuf
	PbEmptyStruct = new(PbEmpty)
)
View Source 
var (
	// ThriftEmptyStruct empty struct for thrift
	ThriftEmptyStruct = new(ThriftEmpty)
)

Functions

func Marshal 

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

Marshal returns the encoding of v.

func MarshalByName 

func MarshalByName(codecName string, v interface{}) ([]byte, error)

MarshalByName returns the encoding of v.

func ProtoMarshal 

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

ProtoMarshal returns the Protobuf encoding of v.

func ProtoUnmarshal 

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

ProtoUnmarshal parses the Protobuf-encoded data and stores the result in the value pointed to by v.

func Reg 

func Reg(codec Codec)

Reg registers Codec.

func ThriftMarshal 

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

ThriftMarshal returns the Thriftbuf encoding of v.

func ThriftUnmarshal 

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

ThriftUnmarshal parses the Thriftbuf-encoded data and stores the result in the value pointed to by v.

func Unmarshal 

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

Unmarshal parses the encoded data and stores the result in the value pointed to by v.

func UnmarshalByName 

func UnmarshalByName(codecName string, data []byte, v interface{}) error

UnmarshalByName parses the encoded data and stores the result in the value pointed to by v.

Types

type Codec 

type Codec interface {
	// ID returns codec id.
	ID() byte
	// Name returns codec name.
	Name() string
	// Marshal returns the encoding of v.
	Marshal(v interface{}) ([]byte, error)
	// Unmarshal parses the encoded data and stores the result
	// in the value pointed to by v.
	Unmarshal(data []byte, v interface{}) error
}

Codec makes the body's Encoder and Decoder

func Get 

func Get(codecID byte) (Codec, error)

Get returns Codec by id.

func GetByName 

func GetByName(codecName string) (Codec, error)

GetByName returns Codec by name.

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)

Marshal returns the url encoded date of v.

func (FormCodec) Name 

func (FormCodec) Name() string

Name returns codec name.

func (FormCodec) Unmarshal 

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

Unmarshal parses the url encoded data and stores the result in the value pointed to by v.

type JSONCodec 

type JSONCodec struct{}

JSONCodec json codec

func (JSONCodec) ID 

func (JSONCodec) ID() byte

ID returns codec id.

func (JSONCodec) Marshal 

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

Marshal returns the JSON encoding of v.

func (JSONCodec) Name 

func (JSONCodec) Name() string

Name returns codec name.

func (JSONCodec) Unmarshal 

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

Unmarshal parses the JSON-encoded data and stores the result in the value pointed to by v.

type PbEmpty 

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

func (*PbEmpty) Descriptor deprecated 

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)

Marshal returns the string encoding of v.

func (PlainCodec) Name 

func (PlainCodec) Name() string

Name returns codec name.

func (PlainCodec) Unmarshal 

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

Unmarshal parses the string-encoded data and stores the result in the value pointed to by v.

type ProtoCodec 

type ProtoCodec struct{}

ProtoCodec protobuf codec

func (ProtoCodec) ID 

func (ProtoCodec) ID() byte

ID returns codec id.

func (ProtoCodec) Marshal 

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

Marshal returns the Protobuf encoding of v.

func (ProtoCodec) Name 

func (ProtoCodec) Name() string

Name returns codec name.

func (ProtoCodec) Unmarshal 

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

Unmarshal parses the Protobuf-encoded data and stores the result in the value pointed to by v.

type ThriftCodec 

type ThriftCodec struct{}

ThriftCodec thrift codec

func (ThriftCodec) ID 

func (ThriftCodec) ID() byte

ID returns codec id.

func (ThriftCodec) Marshal 

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

Marshal returns the Thriftbuf encoding of v.

func (ThriftCodec) Name 

func (ThriftCodec) Name() string

Name returns codec name.

func (ThriftCodec) Unmarshal 

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

Unmarshal parses the Thriftbuf-encoded data and stores the result in the value pointed to by v.

type ThriftEmpty 

type ThriftEmpty struct {
}

func NewThriftEmpty 

func NewThriftEmpty() *ThriftEmpty

func (*ThriftEmpty) Read 

func (p *ThriftEmpty) Read(iprot thrift.TProtocol) error

func (*ThriftEmpty) String 

func (p *ThriftEmpty) String() string

func (*ThriftEmpty) Write 

func (p *ThriftEmpty) Write(oprot thrift.TProtocol) error

type XMLCodec 

type XMLCodec struct{}

XMLCodec xml codec

func (XMLCodec) ID 

func (XMLCodec) ID() byte

ID returns codec id.

func (XMLCodec) Marshal 

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

Marshal returns the XML encoding of v.

func (XMLCodec) Name 

func (XMLCodec) Name() string

Name returns codec name.

func (XMLCodec) Unmarshal 

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

Unmarshal parses the XML-encoded data and stores the result in the value pointed to by v.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.