value

package module
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2020 License: Apache-2.0 Imports: 20 Imported by: 4

README

value

Value in GO

  • All instances are immutable and good for multi-threading or go-routing.
  • Deterministic serialization that guarantee consistent results before hashing.
  • No cycle pack deps, because all objects are immutable
List
v := value.NewList()

v = v.Insert(value.Boolean(true))
v = v.Insert(value.Long(123))
v = v.Insert(value.Double(-12.34))
v = v.Insert(value.Utf8("text"))
v = v.Insert(value.Raw([]byte{0, 1, 2}, false))

mp, _ := value.Pack(v)

c, err := value.Unpack(mp, false)
if err != nil {
    t.Errorf("unpack fail %v", err)
}

require.True(t, v.Equal(c))
Map
b = value.NewMap()

c := value.NewMap()
c.Put("5", value.Long(5))

b.Put("name", value.Utf8("name"))
b.Put("123", value.Long(123))
b.Put("map", c)

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var AllowFastAppends = true
View Source 
var Base64Prefix = "base64,"
View Source 
var DecimalExpDelim = byte('x')
View Source 
var DecimalExpDelimStr = "x"
View Source 
var ErrUnseal = errors.New("unseal error")
View Source 
var False = boolValue(false)
View Source 
var FirstIndexKey = 0
View Source 
var PrecisionLevel = 0.00001
View Source 
var True = boolValue(true)
View Source 
var UnknownPrefix = "data:application/x-msgpack-ext;"

Functions

func Equal added in v1.2.0 

func Equal(left Value, right Value) bool

func Hash added in v1.2.0 

func Hash(val Value, hash crypto.Hash) ([]byte, error)

func Hex 

func Hex(val Value) string

func Jsonify added in v1.3.0 

func Jsonify(val Value) string

func MessagePacker 

func MessagePacker(w io.Writer) *messagePacker

func MessageParser 

func MessageParser() *messageParser

func MessageReader 

func MessageReader(r io.Reader) *messageIOUnpacker

func MessageUnpacker 

func MessageUnpacker(buf []byte, copy bool) *messageBufUnpacker

func Pack 

func Pack(val Value) ([]byte, error)

func ParseBoolean 

func ParseBoolean(str string) boolValue

func ReadStream 

func ReadStream(r io.Reader, out chan<- Value) error

func Seal added in v1.2.0 

func Seal(val Value, recipientPublicKey, senderPrivateKey *[32]byte) ([]byte, error)

use box.GenerateKey(rand.Reader) to get keys

func Unknown 

func Unknown(tagAndData []byte) unknownValue

func UnpackBigInt 

func UnpackBigInt(data []byte) (*big.Int, error)

func UnpackDecimal 

func UnpackDecimal(data []byte) (decimal.Decimal, error)

func Write 

func Write(w io.Writer, val Value) error

func WriteStream 

func WriteStream(w io.Writer, valueC <-chan Value) error

Types

type Bool 

type Bool interface {
	Value

	Boolean() bool
}

func Boolean 

func Boolean(b bool) Bool

type Collection added in v1.2.0 

type Collection interface {
	Len() int

	Entries() []MapEntry
}

type Ext 

type Ext byte
const (
	UnknownExt Ext = iota

	BigIntExt
	DecimalExt

	MaxExt
)

type Extension 

type Extension interface {
	Value

	Native() []byte
}

type Format 

type Format int
const (
	EOF Format = iota
	UnexpectedEOF
	NilToken
	BoolToken
	LongToken
	DoubleToken
	FixExtToken
	BinHeader
	StrHeader
	ListHeader
	MapHeader
	ExtHeader
)

type Kind 

type Kind int
const (
	INVALID Kind = iota
	BOOL
	NUMBER
	STRING
	LIST
	MAP
	UNKNOWN
)

type List 

type List interface {
	Value
	Collection

	Items() []ListItem

	Values() []Value

	GetAt(int) Value

	GetBoolAt(int) Bool

	GetNumberAt(int) Number

	GetStringAt(int) String

	GetListAt(int) List

	GetMapAt(int) Map

	PutAt(int, Value) List

	InsertAt(int, Value) List

	Append(Value) List

	RemoveAt(int) List
}

func EmptyList added in v1.2.0 

func EmptyList() List

func EmptySparseList added in v1.2.0 

func EmptySparseList() List

func Single added in v1.2.1 

func Single(value Value) List

func SolidList added in v1.2.0 

func SolidList(list []Value) List

func SortedSparseList added in v1.2.0 

func SortedSparseList(items []ListItem) List

func SparseList added in v1.2.0 

func SparseList(items []ListItem, sortedItems bool) List

func SparseListOf added in v1.2.0 

func SparseListOf(list []Value) List

func Tuple added in v1.2.1 

func Tuple(values ...Value) List

type ListItem added in v1.2.0 

type ListItem interface {

	/*
		Index in the array where item is located
	*/
	Key() int

	Value() Value

	Equal(ListItem) bool
}

func Item added in v1.2.0 

func Item(key int, value Value) ListItem

type Map 

type Map interface {
	Value
	Collection

	HashMap() map[string]Value

	Keys() []string

	Values() []Value

	Get(string) (Value, bool)

	GetBool(string) Bool

	GetNumber(string) Number

	GetString(string) String

	GetList(string) List

	GetMap(string) Map

	Insert(key string, value Value) Map

	Put(key string, value Value) Map

	Remove(string) Map
}

func EmptyMap added in v1.2.0 

func EmptyMap() Map

func SortedMap added in v1.2.0 

func SortedMap(entries []MapEntry, sortedEntries bool) Map

type MapEntry added in v1.2.0 

type MapEntry interface {
	Key() string

	Value() Value

	Equal(MapEntry) bool
}

func Entry added in v1.2.0 

func Entry(key string, value Value) MapEntry

type Number 

type Number interface {
	Value

	Type() NumberType

	IsNaN() bool

	Long() int64

	Double() float64

	BigInt() *big.Int

	Decimal() decimal.Decimal

	Add(Number) Number

	Subtract(Number) Number
}

func BigInt 

func BigInt(val *big.Int) Number

func Decimal 

func Decimal(dec decimal.Decimal) Number

func Double 

func Double(val float64) Number

func Long 

func Long(val int64) Number

func Nan 

func Nan() Number

func ParseNumber 

func ParseNumber(str string) Number

type NumberType 

type NumberType int
const (
	InvalidNumber NumberType = iota
	LONG
	DOUBLE
	BIGINT
	DECIMAL
)

func (NumberType) String 

func (t NumberType) String() string

type Packer 

type Packer interface {
	PackNil()

	PackBool(bool)

	PackLong(int64)

	PackDouble(float64)

	PackStr(string)

	PackBin([]byte)

	PackExt(xtag Ext, data []byte)

	PackList(int)

	PackMap(int)

	PackRaw([]byte)

	Error() error
}

type Parser 

type Parser interface {
	ParseBool([]byte) bool

	ParseLong([]byte) int64

	ParseDouble([]byte) float64

	ParseBin([]byte) int

	ParseStr([]byte) int

	ParseList([]byte) int

	ParseMap([]byte) int

	ParseExt([]byte) (int, []byte)

	Error() error
}

type String 

type String interface {
	Value

	Type() StringType

	Len() int

	Utf8() string

	Raw() []byte
}

func ParseString 

func ParseString(str string) String

func Raw 

func Raw(val []byte, copyFlag bool) String

func Stringf added in v1.0.1 

func Stringf(format string, args ...interface{}) String

func Utf8 

func Utf8(val string) String

type StringType 

type StringType int
const (
	InvalidString StringType = iota
	UTF8
	RAW
)

func (StringType) String 

func (t StringType) String() string

type Unpacker 

type Unpacker interface {
	Next() (Format, []byte)

	Read(int) ([]byte, error)
}

type Value 

type Value interface {
	fmt.Stringer
	json.Marshaler
	encoding.BinaryMarshaler

	Kind() Kind

	Class() reflect.Type

	Object() interface{}

	Pack(Packer)

	PrintJSON(out *strings.Builder)

	Equal(Value) bool
}

func Parse 

func Parse(unpacker Unpacker, parser Parser) (Value, error)

func Read 

func Read(r io.Reader) (Value, error)

func Unpack 

func Unpack(buf []byte, copy bool) (Value, error)

func Unseal added in v1.2.0 

func Unseal(encrypted []byte, senderPublicKey, recipientPrivateKey *[32]byte) (Value, error)

type Writer 

type Writer interface {
	WriteNil() []byte

	WriteBool(val bool) []byte

	WriteLong(val int64) []byte

	WriteDouble(val float64) []byte

	WriteBinHeader(len int) []byte

	WriteStrHeader(len int) []byte

	WriteExtHeader(len int, xtag byte) []byte

	WriteArrayHeader(len int) []byte

	WriteMapHeader(len int) []byte
}

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.
JackTT - Gopher 🇻🇳