encode.go 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. package msgpack
  2. import (
  3. "bytes"
  4. "io"
  5. "reflect"
  6. "sync"
  7. "time"
  8. "github.com/vmihailenco/msgpack/v5/msgpcode"
  9. )
  10. const (
  11. sortMapKeysFlag uint32 = 1 << iota
  12. arrayEncodedStructsFlag
  13. useCompactIntsFlag
  14. useCompactFloatsFlag
  15. useInternedStringsFlag
  16. omitEmptyFlag
  17. )
  18. type writer interface {
  19. io.Writer
  20. WriteByte(byte) error
  21. }
  22. type byteWriter struct {
  23. io.Writer
  24. }
  25. func newByteWriter(w io.Writer) byteWriter {
  26. return byteWriter{
  27. Writer: w,
  28. }
  29. }
  30. func (bw byteWriter) WriteByte(c byte) error {
  31. _, err := bw.Write([]byte{c})
  32. return err
  33. }
  34. //------------------------------------------------------------------------------
  35. var encPool = sync.Pool{
  36. New: func() interface{} {
  37. return NewEncoder(nil)
  38. },
  39. }
  40. func GetEncoder() *Encoder {
  41. return encPool.Get().(*Encoder)
  42. }
  43. func PutEncoder(enc *Encoder) {
  44. enc.w = nil
  45. encPool.Put(enc)
  46. }
  47. // Marshal returns the MessagePack encoding of v.
  48. func Marshal(v interface{}) ([]byte, error) {
  49. enc := GetEncoder()
  50. var buf bytes.Buffer
  51. enc.Reset(&buf)
  52. err := enc.Encode(v)
  53. b := buf.Bytes()
  54. PutEncoder(enc)
  55. if err != nil {
  56. return nil, err
  57. }
  58. return b, err
  59. }
  60. type Encoder struct {
  61. w writer
  62. dict map[string]int
  63. structTag string
  64. buf []byte
  65. timeBuf []byte
  66. flags uint32
  67. }
  68. // NewEncoder returns a new encoder that writes to w.
  69. func NewEncoder(w io.Writer) *Encoder {
  70. e := &Encoder{
  71. buf: make([]byte, 9),
  72. }
  73. e.Reset(w)
  74. return e
  75. }
  76. // Writer returns the Encoder's writer.
  77. func (e *Encoder) Writer() io.Writer {
  78. return e.w
  79. }
  80. // Reset discards any buffered data, resets all state, and switches the writer to write to w.
  81. func (e *Encoder) Reset(w io.Writer) {
  82. e.ResetDict(w, nil)
  83. }
  84. // ResetDict is like Reset, but also resets the dict.
  85. func (e *Encoder) ResetDict(w io.Writer, dict map[string]int) {
  86. e.ResetWriter(w)
  87. e.flags = 0
  88. e.structTag = ""
  89. e.dict = dict
  90. }
  91. func (e *Encoder) WithDict(dict map[string]int, fn func(*Encoder) error) error {
  92. oldDict := e.dict
  93. e.dict = dict
  94. err := fn(e)
  95. e.dict = oldDict
  96. return err
  97. }
  98. func (e *Encoder) ResetWriter(w io.Writer) {
  99. e.dict = nil
  100. if bw, ok := w.(writer); ok {
  101. e.w = bw
  102. } else if w == nil {
  103. e.w = nil
  104. } else {
  105. e.w = newByteWriter(w)
  106. }
  107. }
  108. // SetSortMapKeys causes the Encoder to encode map keys in increasing order.
  109. // Supported map types are:
  110. // - map[string]string
  111. // - map[string]bool
  112. // - map[string]interface{}
  113. func (e *Encoder) SetSortMapKeys(on bool) *Encoder {
  114. if on {
  115. e.flags |= sortMapKeysFlag
  116. } else {
  117. e.flags &= ^sortMapKeysFlag
  118. }
  119. return e
  120. }
  121. // SetCustomStructTag causes the Encoder to use a custom struct tag as
  122. // fallback option if there is no msgpack tag.
  123. func (e *Encoder) SetCustomStructTag(tag string) {
  124. e.structTag = tag
  125. }
  126. // SetOmitEmpty causes the Encoder to omit empty values by default.
  127. func (e *Encoder) SetOmitEmpty(on bool) {
  128. if on {
  129. e.flags |= omitEmptyFlag
  130. } else {
  131. e.flags &= ^omitEmptyFlag
  132. }
  133. }
  134. // UseArrayEncodedStructs causes the Encoder to encode Go structs as msgpack arrays.
  135. func (e *Encoder) UseArrayEncodedStructs(on bool) {
  136. if on {
  137. e.flags |= arrayEncodedStructsFlag
  138. } else {
  139. e.flags &= ^arrayEncodedStructsFlag
  140. }
  141. }
  142. // UseCompactEncoding causes the Encoder to chose the most compact encoding.
  143. // For example, it allows to encode small Go int64 as msgpack int8 saving 7 bytes.
  144. func (e *Encoder) UseCompactInts(on bool) {
  145. if on {
  146. e.flags |= useCompactIntsFlag
  147. } else {
  148. e.flags &= ^useCompactIntsFlag
  149. }
  150. }
  151. // UseCompactFloats causes the Encoder to chose a compact integer encoding
  152. // for floats that can be represented as integers.
  153. func (e *Encoder) UseCompactFloats(on bool) {
  154. if on {
  155. e.flags |= useCompactFloatsFlag
  156. } else {
  157. e.flags &= ^useCompactFloatsFlag
  158. }
  159. }
  160. // UseInternedStrings causes the Encoder to intern strings.
  161. func (e *Encoder) UseInternedStrings(on bool) {
  162. if on {
  163. e.flags |= useInternedStringsFlag
  164. } else {
  165. e.flags &= ^useInternedStringsFlag
  166. }
  167. }
  168. func (e *Encoder) Encode(v interface{}) error {
  169. switch v := v.(type) {
  170. case nil:
  171. return e.EncodeNil()
  172. case string:
  173. return e.EncodeString(v)
  174. case []byte:
  175. return e.EncodeBytes(v)
  176. case int:
  177. return e.EncodeInt(int64(v))
  178. case int64:
  179. return e.encodeInt64Cond(v)
  180. case uint:
  181. return e.EncodeUint(uint64(v))
  182. case uint64:
  183. return e.encodeUint64Cond(v)
  184. case bool:
  185. return e.EncodeBool(v)
  186. case float32:
  187. return e.EncodeFloat32(v)
  188. case float64:
  189. return e.EncodeFloat64(v)
  190. case time.Duration:
  191. return e.encodeInt64Cond(int64(v))
  192. case time.Time:
  193. return e.EncodeTime(v)
  194. }
  195. return e.EncodeValue(reflect.ValueOf(v))
  196. }
  197. func (e *Encoder) EncodeMulti(v ...interface{}) error {
  198. for _, vv := range v {
  199. if err := e.Encode(vv); err != nil {
  200. return err
  201. }
  202. }
  203. return nil
  204. }
  205. func (e *Encoder) EncodeValue(v reflect.Value) error {
  206. fn := getEncoder(v.Type())
  207. return fn(e, v)
  208. }
  209. func (e *Encoder) EncodeNil() error {
  210. return e.writeCode(msgpcode.Nil)
  211. }
  212. func (e *Encoder) EncodeBool(value bool) error {
  213. if value {
  214. return e.writeCode(msgpcode.True)
  215. }
  216. return e.writeCode(msgpcode.False)
  217. }
  218. func (e *Encoder) EncodeDuration(d time.Duration) error {
  219. return e.EncodeInt(int64(d))
  220. }
  221. func (e *Encoder) writeCode(c byte) error {
  222. return e.w.WriteByte(c)
  223. }
  224. func (e *Encoder) write(b []byte) error {
  225. _, err := e.w.Write(b)
  226. return err
  227. }
  228. func (e *Encoder) writeString(s string) error {
  229. _, err := e.w.Write(stringToBytes(s))
  230. return err
  231. }