README
¶
Types with no-copy decoding
This sub-package contains a set of typed sclices which can be useful for encoding/decoding large numerical slices faster. This is relatively unsafe and non-portable as the encoding simply copies the memory of the slice, hence disregarding byte order of the encoder/decoders. However, this lets us to avoid allocating and copying memory when encoding/decoding, making this at least 10x faster than the safe implementation.
Warning
This implementation simply maps the byte slice provided in Unmarshal call to the Go structs which need to be decoded. This simply reuses the underlying byte array to store the data and does not perform a memory copy. This can be dangerous in many cases, be careful how this is used!
Benchmark
Array of 10K elements:
BenchmarkUint64s_Safe/marshal-8 10000 167612 ns/op 78325 B/op 11 allocs/op
BenchmarkUint64s_Safe/unmarshal-8 5000 286769 ns/op 81975 B/op 2 allocs/op
BenchmarkUint64s_Unsafe/marshal-8 100000 10711 ns/op 82055 B/op 3 allocs/op
BenchmarkUint64s_Unsafe/unmarshal-8 20000000 109 ns/op 0 B/op 0 allocs/op
Usage
This is a drop-in type, so simply use one of the types available in the package (Bools, Int32s, Uint64s ...) and Marshal or Unmarshal using the binary package.
// Marshal some numbers
v := nocopy.Int32s{4, 5, 6, 1, 2, 3}
encoded, err := binary.Marshal(&v)
// Unmarshal the numbers
var o nocopy.Int32s
err = binary.Unmarshal(encoded, &o)
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bools ¶
type Bools []bool
Bools represents a type serialized in an unsafe, non portable manner. Moreover, when decoding it simply reuses the underlying byte array to store the data and does not perform a memory copy. This can be dangerous in many cases, be careful how this is used.
func (*Bools) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type ByteMap ¶ added in v1.0.8
ByteMap represents a map where keys are strings but the values are slices of bytes. It is encoded in an unsafe, non portable mapper.
func (*ByteMap) GetBinaryCodec ¶ added in v1.0.8
GetBinaryCodec retrieves a custom binary codec.
type Bytes ¶
type Bytes []byte
Bytes represents a type serialized in an unsafe, non portable manner. Moreover, when decoding it simply reuses the underlying byte array to store the data and does not perform a memory copy. This can be dangerous in many cases, be careful how this is used.
func (*Bytes) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type Dictionary ¶ added in v1.0.4
Dictionary represents a map where both keys and values are strings. It is serialized in an unsafe, non portable manner.
func (*Dictionary) GetBinaryCodec ¶ added in v1.0.4
func (d *Dictionary) GetBinaryCodec() binary.Codec
GetBinaryCodec retrieves a custom binary codec.
type Float32s ¶
type Float32s []float32
Float32s represents a slice serialized in an unsafe, non portable manner.
func (*Float32s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type Float64s ¶
type Float64s []float64
Float64s represents a slice serialized in an unsafe, non portable manner.
func (*Float64s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type HashMap ¶ added in v1.0.10
HashMap represents a map where keys are uint64 but the values are slices of bytes. It is encoded in an unsafe, non portable mapper.
func (*HashMap) GetBinaryCodec ¶ added in v1.0.10
GetBinaryCodec retrieves a custom binary codec.
type Int16s ¶
type Int16s []int16
Int16s represents a slice serialized in an unsafe, non portable manner.
func (*Int16s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type Int32s ¶
type Int32s []int32
Int32s represents a slice serialized in an unsafe, non portable manner.
func (*Int32s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type Int64s ¶
type Int64s []int64
Int64s represents a slice serialized in an unsafe, non portable manner.
func (*Int64s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type String ¶
type String string
String represents a type serialized in an unsafe, non portable manner. Moreover, when decoding it simply reuses the underlying byte array to store the data and does not perform a memory copy. This can be dangerous in many cases, be careful how this is used.
func (*String) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type Uint16s ¶
type Uint16s []uint16
Uint16s represents a slice serialized in an unsafe, non portable manner.
func (*Uint16s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type Uint32s ¶
type Uint32s []uint32
Uint32s represents a slice serialized in an unsafe, non portable manner.
func (*Uint32s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
type Uint64s ¶
type Uint64s []uint64
Uint64s represents a slice serialized in an unsafe, non portable manner.
func (*Uint64s) GetBinaryCodec ¶
GetBinaryCodec retrieves a custom binary codec.
Source Files