encode.go 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568
  1. // Copyright (c) 2012-2018 Ugorji Nwoke. All rights reserved.
  2. // Use of this source code is governed by a MIT license found in the LICENSE file.
  3. package codec
  4. import (
  5. "encoding"
  6. "errors"
  7. "fmt"
  8. "io"
  9. "reflect"
  10. "sort"
  11. "strconv"
  12. "time"
  13. )
  14. // defEncByteBufSize is the default size of []byte used
  15. // for bufio buffer or []byte (when nil passed)
  16. const defEncByteBufSize = 1 << 10 // 4:16, 6:64, 8:256, 10:1024
  17. var errEncoderNotInitialized = errors.New("Encoder not initialized")
  18. // encDriver abstracts the actual codec (binc vs msgpack, etc)
  19. type encDriver interface {
  20. EncodeNil()
  21. EncodeInt(i int64)
  22. EncodeUint(i uint64)
  23. EncodeBool(b bool)
  24. EncodeFloat32(f float32)
  25. EncodeFloat64(f float64)
  26. // encodeExtPreamble(xtag byte, length int)
  27. EncodeRawExt(re *RawExt)
  28. EncodeExt(v interface{}, xtag uint64, ext Ext)
  29. EncodeStringEnc(c charEncoding, v string) // c cannot be cRAW
  30. // EncodeSymbol(v string)
  31. EncodeStringBytesRaw(v []byte)
  32. EncodeTime(time.Time)
  33. //encBignum(f *big.Int)
  34. //encStringRunes(c charEncoding, v []rune)
  35. WriteArrayStart(length int)
  36. WriteArrayEnd()
  37. WriteMapStart(length int)
  38. WriteMapEnd()
  39. reset()
  40. atEndOfEncode()
  41. }
  42. type encDriverContainerTracker interface {
  43. WriteArrayElem()
  44. WriteMapElemKey()
  45. WriteMapElemValue()
  46. }
  47. type encDriverAsis interface {
  48. EncodeAsis(v []byte)
  49. }
  50. type encodeError struct {
  51. codecError
  52. }
  53. func (e encodeError) Error() string {
  54. return fmt.Sprintf("%s encode error: %v", e.name, e.err)
  55. }
  56. type encDriverNoopContainerWriter struct{}
  57. func (encDriverNoopContainerWriter) WriteArrayStart(length int) {}
  58. func (encDriverNoopContainerWriter) WriteArrayEnd() {}
  59. func (encDriverNoopContainerWriter) WriteMapStart(length int) {}
  60. func (encDriverNoopContainerWriter) WriteMapEnd() {}
  61. func (encDriverNoopContainerWriter) atEndOfEncode() {}
  62. // func (encDriverNoopContainerWriter) WriteArrayElem() {}
  63. // func (encDriverNoopContainerWriter) WriteMapElemKey() {}
  64. // func (encDriverNoopContainerWriter) WriteMapElemValue() {}
  65. // type encDriverTrackContainerWriter struct {
  66. // c containerState
  67. // }
  68. // func (e *encDriverTrackContainerWriter) WriteArrayStart(length int) { e.c = containerArrayStart }
  69. // func (e *encDriverTrackContainerWriter) WriteArrayElem() { e.c = containerArrayElem }
  70. // func (e *encDriverTrackContainerWriter) WriteArrayEnd() { e.c = containerArrayEnd }
  71. // func (e *encDriverTrackContainerWriter) WriteMapStart(length int) { e.c = containerMapStart }
  72. // func (e *encDriverTrackContainerWriter) WriteMapElemKey() { e.c = containerMapKey }
  73. // func (e *encDriverTrackContainerWriter) WriteMapElemValue() { e.c = containerMapValue }
  74. // func (e *encDriverTrackContainerWriter) WriteMapEnd() { e.c = containerMapEnd }
  75. // func (e *encDriverTrackContainerWriter) atEndOfEncode() {}
  76. // EncodeOptions captures configuration options during encode.
  77. type EncodeOptions struct {
  78. // WriterBufferSize is the size of the buffer used when writing.
  79. //
  80. // if > 0, we use a smart buffer internally for performance purposes.
  81. WriterBufferSize int
  82. // ChanRecvTimeout is the timeout used when selecting from a chan.
  83. //
  84. // Configuring this controls how we receive from a chan during the encoding process.
  85. // - If ==0, we only consume the elements currently available in the chan.
  86. // - if <0, we consume until the chan is closed.
  87. // - If >0, we consume until this timeout.
  88. ChanRecvTimeout time.Duration
  89. // StructToArray specifies to encode a struct as an array, and not as a map
  90. StructToArray bool
  91. // Canonical representation means that encoding a value will always result in the same
  92. // sequence of bytes.
  93. //
  94. // This only affects maps, as the iteration order for maps is random.
  95. //
  96. // The implementation MAY use the natural sort order for the map keys if possible:
  97. //
  98. // - If there is a natural sort order (ie for number, bool, string or []byte keys),
  99. // then the map keys are first sorted in natural order and then written
  100. // with corresponding map values to the strema.
  101. // - If there is no natural sort order, then the map keys will first be
  102. // encoded into []byte, and then sorted,
  103. // before writing the sorted keys and the corresponding map values to the stream.
  104. //
  105. Canonical bool
  106. // CheckCircularRef controls whether we check for circular references
  107. // and error fast during an encode.
  108. //
  109. // If enabled, an error is received if a pointer to a struct
  110. // references itself either directly or through one of its fields (iteratively).
  111. //
  112. // This is opt-in, as there may be a performance hit to checking circular references.
  113. CheckCircularRef bool
  114. // RecursiveEmptyCheck controls whether we descend into interfaces, structs and pointers
  115. // when checking if a value is empty.
  116. //
  117. // Note that this may make OmitEmpty more expensive, as it incurs a lot more reflect calls.
  118. RecursiveEmptyCheck bool
  119. // Raw controls whether we encode Raw values.
  120. // This is a "dangerous" option and must be explicitly set.
  121. // If set, we blindly encode Raw values as-is, without checking
  122. // if they are a correct representation of a value in that format.
  123. // If unset, we error out.
  124. Raw bool
  125. // StringToRaw controls how strings are encoded.
  126. //
  127. // As a go string is just an (immutable) sequence of bytes,
  128. // it can be encoded either as raw bytes or as a UTF string.
  129. //
  130. // By default, strings are encoded as UTF-8.
  131. // but can be treated as []byte during an encode.
  132. //
  133. // Note that things which we know (by definition) to be UTF-8
  134. // are ALWAYS encoded as UTF-8 strings.
  135. // These include encoding.TextMarshaler, time.Format calls, struct field names, etc.
  136. StringToRaw bool
  137. // // AsSymbols defines what should be encoded as symbols.
  138. // //
  139. // // Encoding as symbols can reduce the encoded size significantly.
  140. // //
  141. // // However, during decoding, each string to be encoded as a symbol must
  142. // // be checked to see if it has been seen before. Consequently, encoding time
  143. // // will increase if using symbols, because string comparisons has a clear cost.
  144. // //
  145. // // Sample values:
  146. // // AsSymbolNone
  147. // // AsSymbolAll
  148. // // AsSymbolMapStringKeys
  149. // // AsSymbolMapStringKeysFlag | AsSymbolStructFieldNameFlag
  150. // AsSymbols AsSymbolFlag
  151. }
  152. // ---------------------------------------------
  153. func (e *Encoder) rawExt(f *codecFnInfo, rv reflect.Value) {
  154. e.e.EncodeRawExt(rv2i(rv).(*RawExt))
  155. }
  156. func (e *Encoder) ext(f *codecFnInfo, rv reflect.Value) {
  157. e.e.EncodeExt(rv2i(rv), f.xfTag, f.xfFn)
  158. }
  159. func (e *Encoder) selferMarshal(f *codecFnInfo, rv reflect.Value) {
  160. rv2i(rv).(Selfer).CodecEncodeSelf(e)
  161. }
  162. func (e *Encoder) binaryMarshal(f *codecFnInfo, rv reflect.Value) {
  163. bs, fnerr := rv2i(rv).(encoding.BinaryMarshaler).MarshalBinary()
  164. e.marshalRaw(bs, fnerr)
  165. }
  166. func (e *Encoder) textMarshal(f *codecFnInfo, rv reflect.Value) {
  167. bs, fnerr := rv2i(rv).(encoding.TextMarshaler).MarshalText()
  168. e.marshalUtf8(bs, fnerr)
  169. }
  170. func (e *Encoder) jsonMarshal(f *codecFnInfo, rv reflect.Value) {
  171. bs, fnerr := rv2i(rv).(jsonMarshaler).MarshalJSON()
  172. e.marshalAsis(bs, fnerr)
  173. }
  174. func (e *Encoder) raw(f *codecFnInfo, rv reflect.Value) {
  175. e.rawBytes(rv2i(rv).(Raw))
  176. }
  177. func (e *Encoder) kBool(f *codecFnInfo, rv reflect.Value) {
  178. e.e.EncodeBool(rvGetBool(rv))
  179. }
  180. func (e *Encoder) kTime(f *codecFnInfo, rv reflect.Value) {
  181. e.e.EncodeTime(rvGetTime(rv))
  182. }
  183. func (e *Encoder) kString(f *codecFnInfo, rv reflect.Value) {
  184. if e.h.StringToRaw {
  185. e.e.EncodeStringBytesRaw(bytesView(rvGetString(rv)))
  186. } else {
  187. e.e.EncodeStringEnc(cUTF8, rvGetString(rv))
  188. }
  189. }
  190. // func (e *Encoder) kString(f *codecFnInfo, rv reflect.Value) {
  191. // if e.h.StringToRaw {
  192. // e.kStringToRaw(f, rv)
  193. // } else {
  194. // e.kStringEnc(f, rv)
  195. // }
  196. // }
  197. // func (e *Encoder) kStringToRaw(f *codecFnInfo, rv reflect.Value) {
  198. // e.e.EncodeStringBytesRaw(bytesView(rvGetString(rv)))
  199. // }
  200. // func (e *Encoder) kStringEnc(f *codecFnInfo, rv reflect.Value) {
  201. // e.e.EncodeStringEnc(cUTF8, rvGetString(rv))
  202. // }
  203. func (e *Encoder) kFloat64(f *codecFnInfo, rv reflect.Value) {
  204. e.e.EncodeFloat64(rvGetFloat64(rv))
  205. }
  206. func (e *Encoder) kFloat32(f *codecFnInfo, rv reflect.Value) {
  207. e.e.EncodeFloat32(rvGetFloat32(rv))
  208. }
  209. func (e *Encoder) kInt(f *codecFnInfo, rv reflect.Value) {
  210. e.e.EncodeInt(int64(rvGetInt(rv)))
  211. }
  212. func (e *Encoder) kInt8(f *codecFnInfo, rv reflect.Value) {
  213. e.e.EncodeInt(int64(rvGetInt8(rv)))
  214. }
  215. func (e *Encoder) kInt16(f *codecFnInfo, rv reflect.Value) {
  216. e.e.EncodeInt(int64(rvGetInt16(rv)))
  217. }
  218. func (e *Encoder) kInt32(f *codecFnInfo, rv reflect.Value) {
  219. e.e.EncodeInt(int64(rvGetInt32(rv)))
  220. }
  221. func (e *Encoder) kInt64(f *codecFnInfo, rv reflect.Value) {
  222. e.e.EncodeInt(int64(rvGetInt64(rv)))
  223. }
  224. func (e *Encoder) kUint(f *codecFnInfo, rv reflect.Value) {
  225. e.e.EncodeUint(uint64(rvGetUint(rv)))
  226. }
  227. func (e *Encoder) kUint8(f *codecFnInfo, rv reflect.Value) {
  228. e.e.EncodeUint(uint64(rvGetUint8(rv)))
  229. }
  230. func (e *Encoder) kUint16(f *codecFnInfo, rv reflect.Value) {
  231. e.e.EncodeUint(uint64(rvGetUint16(rv)))
  232. }
  233. func (e *Encoder) kUint32(f *codecFnInfo, rv reflect.Value) {
  234. e.e.EncodeUint(uint64(rvGetUint32(rv)))
  235. }
  236. func (e *Encoder) kUint64(f *codecFnInfo, rv reflect.Value) {
  237. e.e.EncodeUint(uint64(rvGetUint64(rv)))
  238. }
  239. func (e *Encoder) kUintptr(f *codecFnInfo, rv reflect.Value) {
  240. e.e.EncodeUint(uint64(rvGetUintptr(rv)))
  241. }
  242. func (e *Encoder) kInvalid(f *codecFnInfo, rv reflect.Value) {
  243. e.e.EncodeNil()
  244. }
  245. func (e *Encoder) kErr(f *codecFnInfo, rv reflect.Value) {
  246. e.errorf("unsupported kind %s, for %#v", rv.Kind(), rv)
  247. }
  248. func chanToSlice(rv reflect.Value, rtelem reflect.Type, timeout time.Duration) (rvcs reflect.Value) {
  249. // TODO: ensure this doesn't mess up anywhere that rv of kind chan is expected
  250. rvcs = reflect.Zero(reflect.SliceOf(rtelem))
  251. if timeout < 0 { // consume until close
  252. for {
  253. recv, recvOk := rv.Recv()
  254. if !recvOk {
  255. break
  256. }
  257. rvcs = reflect.Append(rvcs, recv)
  258. }
  259. } else {
  260. cases := make([]reflect.SelectCase, 2)
  261. cases[0] = reflect.SelectCase{Dir: reflect.SelectRecv, Chan: rv}
  262. if timeout == 0 {
  263. cases[1] = reflect.SelectCase{Dir: reflect.SelectDefault}
  264. } else {
  265. tt := time.NewTimer(timeout)
  266. cases[1] = reflect.SelectCase{Dir: reflect.SelectRecv, Chan: rv4i(tt.C)}
  267. }
  268. for {
  269. chosen, recv, recvOk := reflect.Select(cases)
  270. if chosen == 1 || !recvOk {
  271. break
  272. }
  273. rvcs = reflect.Append(rvcs, recv)
  274. }
  275. }
  276. return
  277. }
  278. func (e *Encoder) kSlice(f *codecFnInfo, rv reflect.Value) {
  279. // array may be non-addressable, so we have to manage with care
  280. // (don't call rv.Bytes, rv.Slice, etc).
  281. // E.g. type struct S{B [2]byte};
  282. // Encode(S{}) will bomb on "panic: slice of unaddressable array".
  283. mbs := f.ti.mbs
  284. if f.seq != seqTypeArray {
  285. if rvIsNil(rv) {
  286. e.e.EncodeNil()
  287. return
  288. }
  289. // If in this method, then there was no extension function defined.
  290. // So it's okay to treat as []byte.
  291. if !mbs && f.ti.rtid == uint8SliceTypId {
  292. e.e.EncodeStringBytesRaw(rvGetBytes(rv))
  293. return
  294. }
  295. }
  296. if f.seq == seqTypeChan && f.ti.chandir&uint8(reflect.RecvDir) == 0 {
  297. e.errorf("send-only channel cannot be encoded")
  298. }
  299. rtelem := f.ti.elem
  300. var l int
  301. // if a slice, array or chan of bytes, treat specially
  302. if !mbs && uint8TypId == rt2id(rtelem) { // NOT rtelem.Kind() == reflect.Uint8
  303. switch f.seq {
  304. case seqTypeSlice:
  305. e.e.EncodeStringBytesRaw(rvGetBytes(rv))
  306. case seqTypeArray:
  307. e.e.EncodeStringBytesRaw(rvGetArrayBytesRO(rv, e.b[:]))
  308. case seqTypeChan:
  309. e.kSliceBytesChan(rv)
  310. }
  311. return
  312. }
  313. // if chan, consume chan into a slice, and work off that slice.
  314. if f.seq == seqTypeChan {
  315. rv = chanToSlice(rv, rtelem, e.h.ChanRecvTimeout)
  316. }
  317. l = rv.Len() // rv may be slice or array
  318. if mbs {
  319. if l%2 == 1 {
  320. e.errorf("mapBySlice requires even slice length, but got %v", l)
  321. return
  322. }
  323. e.mapStart(l / 2)
  324. } else {
  325. e.arrayStart(l)
  326. }
  327. if l > 0 {
  328. var fn *codecFn
  329. for rtelem.Kind() == reflect.Ptr {
  330. rtelem = rtelem.Elem()
  331. }
  332. // if kind is reflect.Interface, do not pre-determine the
  333. // encoding type, because preEncodeValue may break it down to
  334. // a concrete type and kInterface will bomb.
  335. if rtelem.Kind() != reflect.Interface {
  336. fn = e.h.fn(rtelem)
  337. }
  338. for j := 0; j < l; j++ {
  339. if mbs {
  340. if j%2 == 0 {
  341. e.mapElemKey()
  342. } else {
  343. e.mapElemValue()
  344. }
  345. } else {
  346. e.arrayElem()
  347. }
  348. e.encodeValue(rv.Index(j), fn)
  349. }
  350. }
  351. if mbs {
  352. e.mapEnd()
  353. } else {
  354. e.arrayEnd()
  355. }
  356. }
  357. func (e *Encoder) kSliceBytesChan(rv reflect.Value) {
  358. // do not use range, so that the number of elements encoded
  359. // does not change, and encoding does not hang waiting on someone to close chan.
  360. // for b := range rv2i(rv).(<-chan byte) { bs = append(bs, b) }
  361. // ch := rv2i(rv).(<-chan byte) // fix error - that this is a chan byte, not a <-chan byte.
  362. // if rvIsNil(rv) {
  363. // e.e.EncodeNil()
  364. // return
  365. // }
  366. bs := e.b[:0]
  367. irv := rv2i(rv)
  368. ch, ok := irv.(<-chan byte)
  369. if !ok {
  370. ch = irv.(chan byte)
  371. }
  372. L1:
  373. switch timeout := e.h.ChanRecvTimeout; {
  374. case timeout == 0: // only consume available
  375. for {
  376. select {
  377. case b := <-ch:
  378. bs = append(bs, b)
  379. default:
  380. break L1
  381. }
  382. }
  383. case timeout > 0: // consume until timeout
  384. tt := time.NewTimer(timeout)
  385. for {
  386. select {
  387. case b := <-ch:
  388. bs = append(bs, b)
  389. case <-tt.C:
  390. // close(tt.C)
  391. break L1
  392. }
  393. }
  394. default: // consume until close
  395. for b := range ch {
  396. bs = append(bs, b)
  397. }
  398. }
  399. e.e.EncodeStringBytesRaw(bs)
  400. }
  401. func (e *Encoder) kStructNoOmitempty(f *codecFnInfo, rv reflect.Value) {
  402. sfn := structFieldNode{v: rv, update: false}
  403. if f.ti.toArray || e.h.StructToArray { // toArray
  404. e.arrayStart(len(f.ti.sfiSrc))
  405. for _, si := range f.ti.sfiSrc {
  406. e.arrayElem()
  407. e.encodeValue(sfn.field(si), nil)
  408. }
  409. e.arrayEnd()
  410. } else {
  411. e.mapStart(len(f.ti.sfiSort))
  412. for _, si := range f.ti.sfiSort {
  413. e.mapElemKey()
  414. e.kStructFieldKey(f.ti.keyType, si.encNameAsciiAlphaNum, si.encName)
  415. e.mapElemValue()
  416. e.encodeValue(sfn.field(si), nil)
  417. }
  418. e.mapEnd()
  419. }
  420. }
  421. func (e *Encoder) kStructFieldKey(keyType valueType, encNameAsciiAlphaNum bool, encName string) {
  422. encStructFieldKey(encName, e.e, e.w(), keyType, encNameAsciiAlphaNum, e.js)
  423. }
  424. func (e *Encoder) kStruct(f *codecFnInfo, rv reflect.Value) {
  425. var newlen int
  426. toMap := !(f.ti.toArray || e.h.StructToArray)
  427. var mf map[string]interface{}
  428. if f.ti.isFlag(tiflagMissingFielder) {
  429. mf = rv2i(rv).(MissingFielder).CodecMissingFields()
  430. toMap = true
  431. newlen += len(mf)
  432. } else if f.ti.isFlag(tiflagMissingFielderPtr) {
  433. if rv.CanAddr() {
  434. mf = rv2i(rv.Addr()).(MissingFielder).CodecMissingFields()
  435. } else {
  436. // make a new addressable value of same one, and use it
  437. rv2 := reflect.New(rv.Type())
  438. rvSetDirect(rv2.Elem(), rv)
  439. mf = rv2i(rv2).(MissingFielder).CodecMissingFields()
  440. }
  441. toMap = true
  442. newlen += len(mf)
  443. }
  444. newlen += len(f.ti.sfiSrc)
  445. // Use sync.Pool to reduce allocating slices unnecessarily.
  446. // The cost of sync.Pool is less than the cost of new allocation.
  447. //
  448. // Each element of the array pools one of encStructPool(8|16|32|64).
  449. // It allows the re-use of slices up to 64 in length.
  450. // A performance cost of encoding structs was collecting
  451. // which values were empty and should be omitted.
  452. // We needed slices of reflect.Value and string to collect them.
  453. // This shared pool reduces the amount of unnecessary creation we do.
  454. // The cost is that of locking sometimes, but sync.Pool is efficient
  455. // enough to reduce thread contention.
  456. // fmt.Printf(">>>>>>>>>>>>>> encode.kStruct: newlen: %d\n", newlen)
  457. // var spool sfiRvPooler
  458. var fkvs = e.slist.get(newlen)
  459. recur := e.h.RecursiveEmptyCheck
  460. sfn := structFieldNode{v: rv, update: false}
  461. var kv sfiRv
  462. var j int
  463. if toMap {
  464. newlen = 0
  465. for _, si := range f.ti.sfiSort { // use sorted array
  466. // kv.r = si.field(rv, false)
  467. kv.r = sfn.field(si)
  468. if si.omitEmpty() && isEmptyValue(kv.r, e.h.TypeInfos, recur, recur) {
  469. continue
  470. }
  471. kv.v = si // si.encName
  472. fkvs[newlen] = kv
  473. newlen++
  474. }
  475. var mflen int
  476. for k, v := range mf {
  477. if k == "" {
  478. delete(mf, k)
  479. continue
  480. }
  481. if f.ti.infoFieldOmitempty && isEmptyValue(rv4i(v), e.h.TypeInfos, recur, recur) {
  482. delete(mf, k)
  483. continue
  484. }
  485. mflen++
  486. }
  487. // encode it all
  488. e.mapStart(newlen + mflen)
  489. for j = 0; j < newlen; j++ {
  490. kv = fkvs[j]
  491. e.mapElemKey()
  492. e.kStructFieldKey(f.ti.keyType, kv.v.encNameAsciiAlphaNum, kv.v.encName)
  493. e.mapElemValue()
  494. e.encodeValue(kv.r, nil)
  495. }
  496. // now, add the others
  497. for k, v := range mf {
  498. e.mapElemKey()
  499. e.kStructFieldKey(f.ti.keyType, false, k)
  500. e.mapElemValue()
  501. e.encode(v)
  502. }
  503. e.mapEnd()
  504. } else {
  505. newlen = len(f.ti.sfiSrc)
  506. // kv.v = nil
  507. for i, si := range f.ti.sfiSrc { // use unsorted array (to match sequence in struct)
  508. // kv.r = si.field(rv, false)
  509. kv.r = sfn.field(si)
  510. // use the zero value.
  511. // if a reference or struct, set to nil (so you do not output too much)
  512. if si.omitEmpty() && isEmptyValue(kv.r, e.h.TypeInfos, recur, recur) {
  513. switch kv.r.Kind() {
  514. case reflect.Struct, reflect.Interface, reflect.Ptr, reflect.Array, reflect.Map, reflect.Slice:
  515. kv.r = reflect.Value{} //encode as nil
  516. }
  517. }
  518. fkvs[i] = kv
  519. }
  520. // encode it all
  521. e.arrayStart(newlen)
  522. for j = 0; j < newlen; j++ {
  523. e.arrayElem()
  524. e.encodeValue(fkvs[j].r, nil)
  525. }
  526. e.arrayEnd()
  527. }
  528. // do not use defer. Instead, use explicit pool return at end of function.
  529. // defer has a cost we are trying to avoid.
  530. // If there is a panic and these slices are not returned, it is ok.
  531. // spool.end()
  532. e.slist.put(fkvs)
  533. }
  534. func (e *Encoder) kMap(f *codecFnInfo, rv reflect.Value) {
  535. if rvIsNil(rv) {
  536. e.e.EncodeNil()
  537. return
  538. }
  539. l := rv.Len()
  540. e.mapStart(l)
  541. if l == 0 {
  542. e.mapEnd()
  543. return
  544. }
  545. // var asSymbols bool
  546. // determine the underlying key and val encFn's for the map.
  547. // This eliminates some work which is done for each loop iteration i.e.
  548. // rv.Type(), ref.ValueOf(rt).Pointer(), then check map/list for fn.
  549. //
  550. // However, if kind is reflect.Interface, do not pre-determine the
  551. // encoding type, because preEncodeValue may break it down to
  552. // a concrete type and kInterface will bomb.
  553. var keyFn, valFn *codecFn
  554. // rtkeyid := rt2id(f.ti.key)
  555. ktypeKind := f.ti.key.Kind()
  556. vtypeKind := f.ti.elem.Kind()
  557. rtval := f.ti.elem
  558. rtvalkind := vtypeKind
  559. for rtvalkind == reflect.Ptr {
  560. rtval = rtval.Elem()
  561. rtvalkind = rtval.Kind()
  562. }
  563. if rtvalkind != reflect.Interface {
  564. valFn = e.h.fn(rtval)
  565. }
  566. var rvv = mapAddressableRV(f.ti.elem, vtypeKind)
  567. if e.h.Canonical {
  568. e.kMapCanonical(f.ti.key, f.ti.elem, rv, rvv, valFn)
  569. e.mapEnd()
  570. return
  571. }
  572. rtkey := f.ti.key
  573. var keyTypeIsString = stringTypId == rt2id(rtkey) // rtkeyid
  574. if !keyTypeIsString {
  575. for rtkey.Kind() == reflect.Ptr {
  576. rtkey = rtkey.Elem()
  577. }
  578. if rtkey.Kind() != reflect.Interface {
  579. // rtkeyid = rt2id(rtkey)
  580. keyFn = e.h.fn(rtkey)
  581. }
  582. }
  583. var rvk = mapAddressableRV(f.ti.key, ktypeKind)
  584. it := mapRange(rv, rvk, rvv, true)
  585. var vx reflect.Value
  586. for it.Next() {
  587. e.mapElemKey()
  588. if vx = it.Key(); !vx.IsValid() {
  589. vx = rvk
  590. }
  591. if keyTypeIsString {
  592. if e.h.StringToRaw {
  593. e.e.EncodeStringBytesRaw(bytesView(vx.String()))
  594. } else {
  595. e.e.EncodeStringEnc(cUTF8, vx.String())
  596. }
  597. } else {
  598. e.encodeValue(vx, keyFn)
  599. }
  600. e.mapElemValue()
  601. if vx = it.Value(); !vx.IsValid() {
  602. vx = rvv
  603. }
  604. e.encodeValue(vx, valFn)
  605. }
  606. it.Done()
  607. e.mapEnd()
  608. }
  609. func (e *Encoder) kMapCanonical(rtkey, rtval reflect.Type, rv, rvv reflect.Value, valFn *codecFn) {
  610. // we previously did out-of-band if an extension was registered.
  611. // This is not necessary, as the natural kind is sufficient for ordering.
  612. mks := rv.MapKeys()
  613. switch rtkey.Kind() {
  614. case reflect.Bool:
  615. mksv := make([]boolRv, len(mks))
  616. for i, k := range mks {
  617. v := &mksv[i]
  618. v.r = k
  619. v.v = k.Bool()
  620. }
  621. sort.Sort(boolRvSlice(mksv))
  622. for i := range mksv {
  623. e.mapElemKey()
  624. e.e.EncodeBool(mksv[i].v)
  625. e.mapElemValue()
  626. e.encodeValue(mapGet(rv, mksv[i].r, rvv), valFn) // e.encodeValue(rv.MapIndex(mksv[i].r), valFn)
  627. }
  628. case reflect.String:
  629. mksv := make([]stringRv, len(mks))
  630. for i, k := range mks {
  631. v := &mksv[i]
  632. v.r = k
  633. v.v = k.String()
  634. }
  635. sort.Sort(stringRvSlice(mksv))
  636. for i := range mksv {
  637. e.mapElemKey()
  638. if e.h.StringToRaw {
  639. e.e.EncodeStringBytesRaw(bytesView(mksv[i].v))
  640. } else {
  641. e.e.EncodeStringEnc(cUTF8, mksv[i].v)
  642. }
  643. e.mapElemValue()
  644. e.encodeValue(mapGet(rv, mksv[i].r, rvv), valFn) // e.encodeValue(rv.MapIndex(mksv[i].r), valFn)
  645. }
  646. case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint, reflect.Uintptr:
  647. mksv := make([]uint64Rv, len(mks))
  648. for i, k := range mks {
  649. v := &mksv[i]
  650. v.r = k
  651. v.v = k.Uint()
  652. }
  653. sort.Sort(uint64RvSlice(mksv))
  654. for i := range mksv {
  655. e.mapElemKey()
  656. e.e.EncodeUint(mksv[i].v)
  657. e.mapElemValue()
  658. e.encodeValue(mapGet(rv, mksv[i].r, rvv), valFn) // e.encodeValue(rv.MapIndex(mksv[i].r), valFn)
  659. }
  660. case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
  661. mksv := make([]int64Rv, len(mks))
  662. for i, k := range mks {
  663. v := &mksv[i]
  664. v.r = k
  665. v.v = k.Int()
  666. }
  667. sort.Sort(int64RvSlice(mksv))
  668. for i := range mksv {
  669. e.mapElemKey()
  670. e.e.EncodeInt(mksv[i].v)
  671. e.mapElemValue()
  672. e.encodeValue(mapGet(rv, mksv[i].r, rvv), valFn) // e.encodeValue(rv.MapIndex(mksv[i].r), valFn)
  673. }
  674. case reflect.Float32:
  675. mksv := make([]float64Rv, len(mks))
  676. for i, k := range mks {
  677. v := &mksv[i]
  678. v.r = k
  679. v.v = k.Float()
  680. }
  681. sort.Sort(float64RvSlice(mksv))
  682. for i := range mksv {
  683. e.mapElemKey()
  684. e.e.EncodeFloat32(float32(mksv[i].v))
  685. e.mapElemValue()
  686. e.encodeValue(mapGet(rv, mksv[i].r, rvv), valFn) // e.encodeValue(rv.MapIndex(mksv[i].r), valFn)
  687. }
  688. case reflect.Float64:
  689. mksv := make([]float64Rv, len(mks))
  690. for i, k := range mks {
  691. v := &mksv[i]
  692. v.r = k
  693. v.v = k.Float()
  694. }
  695. sort.Sort(float64RvSlice(mksv))
  696. for i := range mksv {
  697. e.mapElemKey()
  698. e.e.EncodeFloat64(mksv[i].v)
  699. e.mapElemValue()
  700. e.encodeValue(mapGet(rv, mksv[i].r, rvv), valFn) // e.encodeValue(rv.MapIndex(mksv[i].r), valFn)
  701. }
  702. case reflect.Struct:
  703. if rtkey == timeTyp {
  704. mksv := make([]timeRv, len(mks))
  705. for i, k := range mks {
  706. v := &mksv[i]
  707. v.r = k
  708. v.v = rv2i(k).(time.Time)
  709. }
  710. sort.Sort(timeRvSlice(mksv))
  711. for i := range mksv {
  712. e.mapElemKey()
  713. e.e.EncodeTime(mksv[i].v)
  714. e.mapElemValue()
  715. e.encodeValue(mapGet(rv, mksv[i].r, rvv), valFn)
  716. }
  717. break
  718. }
  719. fallthrough
  720. default:
  721. // out-of-band
  722. // first encode each key to a []byte first, then sort them, then record
  723. // var bufp bytesBufPooler
  724. // var mksv []byte = bufp.get(len(mks) * 16)[:0]
  725. // var mksv []byte = make([]byte, 0, len(mks)*16)
  726. var mksv []byte = e.blist.get(len(mks) * 16)[:0]
  727. e2 := NewEncoderBytes(&mksv, e.hh)
  728. mksbv := make([]bytesRv, len(mks))
  729. for i, k := range mks {
  730. v := &mksbv[i]
  731. l := len(mksv)
  732. e2.MustEncode(k)
  733. v.r = k
  734. v.v = mksv[l:]
  735. }
  736. sort.Sort(bytesRvSlice(mksbv))
  737. for j := range mksbv {
  738. e.mapElemKey()
  739. e.asis(mksbv[j].v)
  740. e.mapElemValue()
  741. e.encodeValue(mapGet(rv, mksbv[j].r, rvv), valFn)
  742. }
  743. // bufp.end()
  744. e.blist.put(mksv)
  745. }
  746. }
  747. // Encoder writes an object to an output stream in a supported format.
  748. //
  749. // Encoder is NOT safe for concurrent use i.e. a Encoder cannot be used
  750. // concurrently in multiple goroutines.
  751. //
  752. // However, as Encoder could be allocation heavy to initialize, a Reset method is provided
  753. // so its state can be reused to decode new input streams repeatedly.
  754. // This is the idiomatic way to use.
  755. type Encoder struct {
  756. panicHdl
  757. // hopefully, reduce derefencing cost by laying the encWriter inside the Encoder
  758. e encDriver
  759. // NOTE: Encoder shouldn't call it's write methods,
  760. // as the handler MAY need to do some coordination.
  761. // w *encWr
  762. // bw *bufio.Writer
  763. as encDriverAsis
  764. jenc *jsonEncDriver
  765. h *BasicHandle
  766. hh Handle
  767. // ---- cpu cache line boundary
  768. encWr
  769. err error
  770. // ---- cpu cache line boundary
  771. // ---- writable fields during execution --- *try* to keep in sep cache line
  772. ci set // holds set of addresses found during an encoding (if CheckCircularRef=true)
  773. // cidef [1]interface{} // default ci
  774. b [(7 * 8)]byte // for encoding chan byte, (non-addressable) [N]byte, etc
  775. slist sfiRvFreelist
  776. blist bytesFreelist
  777. // ---- cpu cache line boundary?
  778. // b [scratchByteArrayLen]byte
  779. // _ [cacheLineSize - scratchByteArrayLen]byte // padding
  780. // b [cacheLineSize - (8 * 0)]byte // used for encoding a chan or (non-addressable) array of bytes
  781. }
  782. // NewEncoder returns an Encoder for encoding into an io.Writer.
  783. //
  784. // For efficiency, Users are encouraged to configure WriterBufferSize on the handle
  785. // OR pass in a memory buffered writer (eg bufio.Writer, bytes.Buffer).
  786. func NewEncoder(w io.Writer, h Handle) *Encoder {
  787. e := newEncoder(h)
  788. e.Reset(w)
  789. return e
  790. }
  791. // NewEncoderBytes returns an encoder for encoding directly and efficiently
  792. // into a byte slice, using zero-copying to temporary slices.
  793. //
  794. // It will potentially replace the output byte slice pointed to.
  795. // After encoding, the out parameter contains the encoded contents.
  796. func NewEncoderBytes(out *[]byte, h Handle) *Encoder {
  797. e := newEncoder(h)
  798. e.ResetBytes(out)
  799. return e
  800. }
  801. func newEncoder(h Handle) *Encoder {
  802. e := &Encoder{h: basicHandle(h), err: errEncoderNotInitialized}
  803. e.bytes = true
  804. if useFinalizers {
  805. // runtime.SetFinalizer(e, (*Encoder).finalize)
  806. }
  807. // e.w = &e.encWr
  808. e.hh = h
  809. // e.esep = h.hasElemSeparators()
  810. e.e = e.hh.newEncDriver(e)
  811. e.as, e.isas = e.e.(encDriverAsis)
  812. e.be = e.hh.isBinary()
  813. e.jenc = nil
  814. _, e.js = e.hh.(*JsonHandle)
  815. if e.js {
  816. e.jenc = e.e.(*jsonEncDriver)
  817. }
  818. return e
  819. }
  820. func (e *Encoder) w() *encWr {
  821. return &e.encWr
  822. }
  823. func (e *Encoder) resetCommon() {
  824. e.e.reset()
  825. if e.ci == nil {
  826. // e.ci = (set)(e.cidef[:0])
  827. } else {
  828. e.ci = e.ci[:0]
  829. }
  830. e.c = 0
  831. e.err = nil
  832. }
  833. // Reset resets the Encoder with a new output stream.
  834. //
  835. // This accommodates using the state of the Encoder,
  836. // where it has "cached" information about sub-engines.
  837. func (e *Encoder) Reset(w io.Writer) {
  838. if w == nil {
  839. return
  840. }
  841. // var ok bool
  842. e.bytes = false
  843. if e.wf == nil {
  844. e.wf = new(bufioEncWriter)
  845. }
  846. // e.typ = entryTypeUnset
  847. // if e.h.WriterBufferSize > 0 {
  848. // // bw := bufio.NewWriterSize(w, e.h.WriterBufferSize)
  849. // // e.wi.bw = bw
  850. // // e.wi.sw = bw
  851. // // e.wi.fw = bw
  852. // // e.wi.ww = bw
  853. // if e.wf == nil {
  854. // e.wf = new(bufioEncWriter)
  855. // }
  856. // e.wf.reset(w, e.h.WriterBufferSize)
  857. // e.typ = entryTypeBufio
  858. // } else {
  859. // if e.wi == nil {
  860. // e.wi = new(ioEncWriter)
  861. // }
  862. // e.wi.reset(w)
  863. // e.typ = entryTypeIo
  864. // }
  865. e.wf.reset(w, e.h.WriterBufferSize, &e.blist)
  866. // e.typ = entryTypeBufio
  867. // e.w = e.wi
  868. e.resetCommon()
  869. }
  870. // ResetBytes resets the Encoder with a new destination output []byte.
  871. func (e *Encoder) ResetBytes(out *[]byte) {
  872. if out == nil {
  873. return
  874. }
  875. var in []byte = *out
  876. if in == nil {
  877. in = make([]byte, defEncByteBufSize)
  878. }
  879. e.bytes = true
  880. // e.typ = entryTypeBytes
  881. e.wb.reset(in, out)
  882. // e.w = &e.wb
  883. e.resetCommon()
  884. }
  885. // Encode writes an object into a stream.
  886. //
  887. // Encoding can be configured via the struct tag for the fields.
  888. // The key (in the struct tags) that we look at is configurable.
  889. //
  890. // By default, we look up the "codec" key in the struct field's tags,
  891. // and fall bak to the "json" key if "codec" is absent.
  892. // That key in struct field's tag value is the key name,
  893. // followed by an optional comma and options.
  894. //
  895. // To set an option on all fields (e.g. omitempty on all fields), you
  896. // can create a field called _struct, and set flags on it. The options
  897. // which can be set on _struct are:
  898. // - omitempty: so all fields are omitted if empty
  899. // - toarray: so struct is encoded as an array
  900. // - int: so struct key names are encoded as signed integers (instead of strings)
  901. // - uint: so struct key names are encoded as unsigned integers (instead of strings)
  902. // - float: so struct key names are encoded as floats (instead of strings)
  903. // More details on these below.
  904. //
  905. // Struct values "usually" encode as maps. Each exported struct field is encoded unless:
  906. // - the field's tag is "-", OR
  907. // - the field is empty (empty or the zero value) and its tag specifies the "omitempty" option.
  908. //
  909. // When encoding as a map, the first string in the tag (before the comma)
  910. // is the map key string to use when encoding.
  911. // ...
  912. // This key is typically encoded as a string.
  913. // However, there are instances where the encoded stream has mapping keys encoded as numbers.
  914. // For example, some cbor streams have keys as integer codes in the stream, but they should map
  915. // to fields in a structured object. Consequently, a struct is the natural representation in code.
  916. // For these, configure the struct to encode/decode the keys as numbers (instead of string).
  917. // This is done with the int,uint or float option on the _struct field (see above).
  918. //
  919. // However, struct values may encode as arrays. This happens when:
  920. // - StructToArray Encode option is set, OR
  921. // - the tag on the _struct field sets the "toarray" option
  922. // Note that omitempty is ignored when encoding struct values as arrays,
  923. // as an entry must be encoded for each field, to maintain its position.
  924. //
  925. // Values with types that implement MapBySlice are encoded as stream maps.
  926. //
  927. // The empty values (for omitempty option) are false, 0, any nil pointer
  928. // or interface value, and any array, slice, map, or string of length zero.
  929. //
  930. // Anonymous fields are encoded inline except:
  931. // - the struct tag specifies a replacement name (first value)
  932. // - the field is of an interface type
  933. //
  934. // Examples:
  935. //
  936. // // NOTE: 'json:' can be used as struct tag key, in place 'codec:' below.
  937. // type MyStruct struct {
  938. // _struct bool `codec:",omitempty"` //set omitempty for every field
  939. // Field1 string `codec:"-"` //skip this field
  940. // Field2 int `codec:"myName"` //Use key "myName" in encode stream
  941. // Field3 int32 `codec:",omitempty"` //use key "Field3". Omit if empty.
  942. // Field4 bool `codec:"f4,omitempty"` //use key "f4". Omit if empty.
  943. // io.Reader //use key "Reader".
  944. // MyStruct `codec:"my1" //use key "my1".
  945. // MyStruct //inline it
  946. // ...
  947. // }
  948. //
  949. // type MyStruct struct {
  950. // _struct bool `codec:",toarray"` //encode struct as an array
  951. // }
  952. //
  953. // type MyStruct struct {
  954. // _struct bool `codec:",uint"` //encode struct with "unsigned integer" keys
  955. // Field1 string `codec:"1"` //encode Field1 key using: EncodeInt(1)
  956. // Field2 string `codec:"2"` //encode Field2 key using: EncodeInt(2)
  957. // }
  958. //
  959. // The mode of encoding is based on the type of the value. When a value is seen:
  960. // - If a Selfer, call its CodecEncodeSelf method
  961. // - If an extension is registered for it, call that extension function
  962. // - If implements encoding.(Binary|Text|JSON)Marshaler, call Marshal(Binary|Text|JSON) method
  963. // - Else encode it based on its reflect.Kind
  964. //
  965. // Note that struct field names and keys in map[string]XXX will be treated as symbols.
  966. // Some formats support symbols (e.g. binc) and will properly encode the string
  967. // only once in the stream, and use a tag to refer to it thereafter.
  968. func (e *Encoder) Encode(v interface{}) (err error) {
  969. // tried to use closure, as runtime optimizes defer with no params.
  970. // This seemed to be causing weird issues (like circular reference found, unexpected panic, etc).
  971. // Also, see https://github.com/golang/go/issues/14939#issuecomment-417836139
  972. // defer func() { e.deferred(&err) }() }
  973. // { x, y := e, &err; defer func() { x.deferred(y) }() }
  974. if e.err != nil {
  975. return e.err
  976. }
  977. if recoverPanicToErr {
  978. defer func() {
  979. // if error occurred during encoding, return that error;
  980. // else if error occurred on end'ing (i.e. during flush), return that error.
  981. err = e.w().endErr()
  982. x := recover()
  983. if x == nil {
  984. if e.err != err {
  985. e.err = err
  986. }
  987. } else {
  988. panicValToErr(e, x, &e.err)
  989. if e.err != err {
  990. err = e.err
  991. }
  992. }
  993. }()
  994. }
  995. // defer e.deferred(&err)
  996. e.mustEncode(v)
  997. return
  998. }
  999. // MustEncode is like Encode, but panics if unable to Encode.
  1000. // This provides insight to the code location that triggered the error.
  1001. func (e *Encoder) MustEncode(v interface{}) {
  1002. if e.err != nil {
  1003. panic(e.err)
  1004. }
  1005. e.mustEncode(v)
  1006. }
  1007. func (e *Encoder) mustEncode(v interface{}) {
  1008. // if e.wf == nil {
  1009. // e.encode(v)
  1010. // e.e.atEndOfEncode()
  1011. // e.w().end()
  1012. // return
  1013. // }
  1014. // if e.wf.buf == nil {
  1015. // e.wf.buf = e.wf.bytesBufPooler.get(e.wf.sz)
  1016. // e.wf.buf = e.wf.buf[:cap(e.wf.buf)]
  1017. // }
  1018. e.calls++
  1019. e.encode(v)
  1020. e.calls--
  1021. if e.calls == 0 {
  1022. e.e.atEndOfEncode()
  1023. e.w().end()
  1024. // if !e.h.ExplicitRelease {
  1025. // e.Release()
  1026. // }
  1027. }
  1028. }
  1029. // func (e *Encoder) deferred(err1 *error) {
  1030. // e.w().end()
  1031. // if recoverPanicToErr {
  1032. // if x := recover(); x != nil {
  1033. // panicValToErr(e, x, err1)
  1034. // panicValToErr(e, x, &e.err)
  1035. // }
  1036. // }
  1037. // }
  1038. // //go:noinline -- as it is run by finalizer
  1039. // func (e *Encoder) finalize() {
  1040. // e.Release()
  1041. // }
  1042. // Release releases shared (pooled) resources.
  1043. //
  1044. // It is important to call Release() when done with an Encoder, so those resources
  1045. // are released instantly for use by subsequently created Encoders.
  1046. //
  1047. // Deprecated: Release is a no-op as pooled resources are not used with an Encoder.
  1048. // This method is kept for compatibility reasons only.
  1049. func (e *Encoder) Release() {
  1050. // if e.wf != nil {
  1051. // e.wf.release()
  1052. // }
  1053. }
  1054. func (e *Encoder) encode(iv interface{}) {
  1055. // a switch with only concrete types can be optimized.
  1056. // consequently, we deal with nil and interfaces outside the switch.
  1057. if iv == nil {
  1058. e.e.EncodeNil()
  1059. return
  1060. }
  1061. rv, ok := isNil(iv)
  1062. if ok {
  1063. e.e.EncodeNil()
  1064. return
  1065. }
  1066. var vself Selfer
  1067. switch v := iv.(type) {
  1068. // case nil:
  1069. // case Selfer:
  1070. case Raw:
  1071. e.rawBytes(v)
  1072. case reflect.Value:
  1073. e.encodeValue(v, nil)
  1074. case string:
  1075. if e.h.StringToRaw {
  1076. e.e.EncodeStringBytesRaw(bytesView(v))
  1077. } else {
  1078. e.e.EncodeStringEnc(cUTF8, v)
  1079. }
  1080. case bool:
  1081. e.e.EncodeBool(v)
  1082. case int:
  1083. e.e.EncodeInt(int64(v))
  1084. case int8:
  1085. e.e.EncodeInt(int64(v))
  1086. case int16:
  1087. e.e.EncodeInt(int64(v))
  1088. case int32:
  1089. e.e.EncodeInt(int64(v))
  1090. case int64:
  1091. e.e.EncodeInt(v)
  1092. case uint:
  1093. e.e.EncodeUint(uint64(v))
  1094. case uint8:
  1095. e.e.EncodeUint(uint64(v))
  1096. case uint16:
  1097. e.e.EncodeUint(uint64(v))
  1098. case uint32:
  1099. e.e.EncodeUint(uint64(v))
  1100. case uint64:
  1101. e.e.EncodeUint(v)
  1102. case uintptr:
  1103. e.e.EncodeUint(uint64(v))
  1104. case float32:
  1105. e.e.EncodeFloat32(v)
  1106. case float64:
  1107. e.e.EncodeFloat64(v)
  1108. case time.Time:
  1109. e.e.EncodeTime(v)
  1110. case []uint8:
  1111. e.e.EncodeStringBytesRaw(v)
  1112. case *Raw:
  1113. e.rawBytes(*v)
  1114. case *string:
  1115. if e.h.StringToRaw {
  1116. e.e.EncodeStringBytesRaw(bytesView(*v))
  1117. } else {
  1118. e.e.EncodeStringEnc(cUTF8, *v)
  1119. }
  1120. case *bool:
  1121. e.e.EncodeBool(*v)
  1122. case *int:
  1123. e.e.EncodeInt(int64(*v))
  1124. case *int8:
  1125. e.e.EncodeInt(int64(*v))
  1126. case *int16:
  1127. e.e.EncodeInt(int64(*v))
  1128. case *int32:
  1129. e.e.EncodeInt(int64(*v))
  1130. case *int64:
  1131. e.e.EncodeInt(*v)
  1132. case *uint:
  1133. e.e.EncodeUint(uint64(*v))
  1134. case *uint8:
  1135. e.e.EncodeUint(uint64(*v))
  1136. case *uint16:
  1137. e.e.EncodeUint(uint64(*v))
  1138. case *uint32:
  1139. e.e.EncodeUint(uint64(*v))
  1140. case *uint64:
  1141. e.e.EncodeUint(*v)
  1142. case *uintptr:
  1143. e.e.EncodeUint(uint64(*v))
  1144. case *float32:
  1145. e.e.EncodeFloat32(*v)
  1146. case *float64:
  1147. e.e.EncodeFloat64(*v)
  1148. case *time.Time:
  1149. e.e.EncodeTime(*v)
  1150. case *[]uint8:
  1151. if *v == nil {
  1152. e.e.EncodeNil()
  1153. } else {
  1154. e.e.EncodeStringBytesRaw(*v)
  1155. }
  1156. default:
  1157. if vself, ok = iv.(Selfer); ok {
  1158. vself.CodecEncodeSelf(e)
  1159. } else if !fastpathEncodeTypeSwitch(iv, e) {
  1160. if !rv.IsValid() {
  1161. rv = rv4i(iv)
  1162. }
  1163. e.encodeValue(rv, nil)
  1164. }
  1165. }
  1166. }
  1167. func (e *Encoder) encodeValue(rv reflect.Value, fn *codecFn) {
  1168. // if a valid fn is passed, it MUST BE for the dereferenced type of rv
  1169. // We considered using a uintptr (a pointer) retrievable via rv.UnsafeAddr.
  1170. // However, it is possible for the same pointer to point to 2 different types e.g.
  1171. // type T struct { tHelper }
  1172. // Here, for var v T; &v and &v.tHelper are the same pointer.
  1173. // Consequently, we need a tuple of type and pointer, which interface{} natively provides.
  1174. var sptr interface{} // uintptr
  1175. var rvp reflect.Value
  1176. var rvpValid bool
  1177. TOP:
  1178. switch rv.Kind() {
  1179. case reflect.Ptr:
  1180. if rvIsNil(rv) {
  1181. e.e.EncodeNil()
  1182. return
  1183. }
  1184. rvpValid = true
  1185. rvp = rv
  1186. rv = rv.Elem()
  1187. if e.h.CheckCircularRef && rv.Kind() == reflect.Struct {
  1188. sptr = rv2i(rvp) // rv.UnsafeAddr()
  1189. break TOP
  1190. }
  1191. goto TOP
  1192. case reflect.Interface:
  1193. if rvIsNil(rv) {
  1194. e.e.EncodeNil()
  1195. return
  1196. }
  1197. rv = rv.Elem()
  1198. goto TOP
  1199. case reflect.Slice, reflect.Map:
  1200. if rvIsNil(rv) {
  1201. e.e.EncodeNil()
  1202. return
  1203. }
  1204. case reflect.Invalid, reflect.Func:
  1205. e.e.EncodeNil()
  1206. return
  1207. }
  1208. if sptr != nil && (&e.ci).add(sptr) {
  1209. // e.errorf("circular reference found: # %d", sptr)
  1210. e.errorf("circular reference found: # %p, %T", sptr, sptr)
  1211. }
  1212. var rt reflect.Type
  1213. if fn == nil {
  1214. rt = rv.Type()
  1215. fn = e.h.fn(rt)
  1216. }
  1217. if fn.i.addrE {
  1218. if rvpValid {
  1219. fn.fe(e, &fn.i, rvp)
  1220. } else if rv.CanAddr() {
  1221. fn.fe(e, &fn.i, rv.Addr())
  1222. } else {
  1223. if rt == nil {
  1224. rt = rv.Type()
  1225. }
  1226. rv2 := reflect.New(rt)
  1227. rvSetDirect(rv2.Elem(), rv)
  1228. fn.fe(e, &fn.i, rv2)
  1229. }
  1230. } else {
  1231. fn.fe(e, &fn.i, rv)
  1232. }
  1233. if sptr != 0 {
  1234. (&e.ci).remove(sptr)
  1235. }
  1236. }
  1237. // func (e *Encoder) marshal(bs []byte, fnerr error, asis bool, c charEncoding) {
  1238. // if fnerr != nil {
  1239. // panic(fnerr)
  1240. // }
  1241. // if bs == nil {
  1242. // e.e.EncodeNil()
  1243. // } else if asis {
  1244. // e.asis(bs)
  1245. // } else {
  1246. // e.e.EncodeStringBytesRaw(bs)
  1247. // }
  1248. // }
  1249. func (e *Encoder) marshalUtf8(bs []byte, fnerr error) {
  1250. if fnerr != nil {
  1251. panic(fnerr)
  1252. }
  1253. if bs == nil {
  1254. e.e.EncodeNil()
  1255. } else {
  1256. e.e.EncodeStringEnc(cUTF8, stringView(bs))
  1257. }
  1258. }
  1259. func (e *Encoder) marshalAsis(bs []byte, fnerr error) {
  1260. if fnerr != nil {
  1261. panic(fnerr)
  1262. }
  1263. if bs == nil {
  1264. e.e.EncodeNil()
  1265. } else {
  1266. e.asis(bs)
  1267. }
  1268. }
  1269. func (e *Encoder) marshalRaw(bs []byte, fnerr error) {
  1270. if fnerr != nil {
  1271. panic(fnerr)
  1272. }
  1273. if bs == nil {
  1274. e.e.EncodeNil()
  1275. } else {
  1276. e.e.EncodeStringBytesRaw(bs)
  1277. }
  1278. }
  1279. func (e *Encoder) asis(v []byte) {
  1280. if e.isas {
  1281. e.as.EncodeAsis(v)
  1282. } else {
  1283. e.w().writeb(v)
  1284. }
  1285. }
  1286. func (e *Encoder) rawBytes(vv Raw) {
  1287. v := []byte(vv)
  1288. if !e.h.Raw {
  1289. e.errorf("Raw values cannot be encoded: %v", v)
  1290. }
  1291. e.asis(v)
  1292. }
  1293. func (e *Encoder) wrapErr(v interface{}, err *error) {
  1294. *err = encodeError{codecError{name: e.hh.Name(), err: v}}
  1295. }
  1296. // ---- container tracker methods
  1297. // Note: We update the .c after calling the callback.
  1298. // This way, the callback can know what the last status was.
  1299. func (e *Encoder) mapStart(length int) {
  1300. e.e.WriteMapStart(length)
  1301. e.c = containerMapStart
  1302. }
  1303. func (e *Encoder) mapElemKey() {
  1304. if e.js {
  1305. e.jenc.WriteMapElemKey()
  1306. }
  1307. e.c = containerMapKey
  1308. }
  1309. func (e *Encoder) mapElemValue() {
  1310. if e.js {
  1311. e.jenc.WriteMapElemValue()
  1312. }
  1313. e.c = containerMapValue
  1314. }
  1315. // // Note: This is harder to inline, as there are 2 function calls inside.
  1316. // func (e *Encoder) mapElemKeyOrValue(j uint8) {
  1317. // if j == 0 {
  1318. // if e.js {
  1319. // e.jenc.WriteMapElemKey()
  1320. // }
  1321. // e.c = containerMapKey
  1322. // } else {
  1323. // if e.js {
  1324. // e.jenc.WriteMapElemValue()
  1325. // }
  1326. // e.c = containerMapValue
  1327. // }
  1328. // }
  1329. func (e *Encoder) mapEnd() {
  1330. e.e.WriteMapEnd()
  1331. e.c = containerMapEnd
  1332. e.c = 0
  1333. }
  1334. func (e *Encoder) arrayStart(length int) {
  1335. e.e.WriteArrayStart(length)
  1336. e.c = containerArrayStart
  1337. }
  1338. func (e *Encoder) arrayElem() {
  1339. if e.js {
  1340. e.jenc.WriteArrayElem()
  1341. }
  1342. e.c = containerArrayElem
  1343. }
  1344. func (e *Encoder) arrayEnd() {
  1345. e.e.WriteArrayEnd()
  1346. e.c = 0
  1347. e.c = containerArrayEnd
  1348. }
  1349. // ----------
  1350. func (e *Encoder) sideEncode(v interface{}, bs *[]byte) {
  1351. rv := baseRV(v)
  1352. e2 := NewEncoderBytes(bs, e.hh)
  1353. e2.encodeValue(rv, e.h.fnNoExt(rv.Type()))
  1354. e2.e.atEndOfEncode()
  1355. e2.w().end()
  1356. }
  1357. func encStructFieldKey(encName string, ee encDriver, w *encWr,
  1358. keyType valueType, encNameAsciiAlphaNum bool, js bool) {
  1359. var m must
  1360. // use if-else-if, not switch (which compiles to binary-search)
  1361. // since keyType is typically valueTypeString, branch prediction is pretty good.
  1362. if keyType == valueTypeString {
  1363. if js && encNameAsciiAlphaNum { // keyType == valueTypeString
  1364. w.writeqstr(encName)
  1365. // ----
  1366. // w.writen1('"')
  1367. // w.writestr(encName)
  1368. // w.writen1('"')
  1369. // ----
  1370. // w.writestr(`"` + encName + `"`)
  1371. // ----
  1372. // // do concat myself, so it is faster than the generic string concat
  1373. // b := make([]byte, len(encName)+2)
  1374. // copy(b[1:], encName)
  1375. // b[0] = '"'
  1376. // b[len(b)-1] = '"'
  1377. // w.writeb(b)
  1378. } else { // keyType == valueTypeString
  1379. ee.EncodeStringEnc(cUTF8, encName)
  1380. }
  1381. } else if keyType == valueTypeInt {
  1382. ee.EncodeInt(m.Int(strconv.ParseInt(encName, 10, 64)))
  1383. } else if keyType == valueTypeUint {
  1384. ee.EncodeUint(m.Uint(strconv.ParseUint(encName, 10, 64)))
  1385. } else if keyType == valueTypeFloat {
  1386. ee.EncodeFloat64(m.Float(strconv.ParseFloat(encName, 64)))
  1387. }
  1388. }
  1389. // type encExtPreambler interface {
  1390. // encodeExtPreamble(tag uint8, length int)
  1391. // }
  1392. // func encBytesExt(rv interface{}, xtag uint64, ext Ext, h Handle, e encDriver) {
  1393. // var bs []byte
  1394. // var bufp bytesBufPooler
  1395. // if ext == SelfExt {
  1396. // bs = bufp.get(1024)[:0]
  1397. // rv2 := rv4i(v)
  1398. // NewEncoderBytes(&bs, h).encodeValue(rv2, h.fnNoExt(rv2.Type()))
  1399. // } else {
  1400. // bs = ext.WriteExt(v)
  1401. // }
  1402. // if bs == nil {
  1403. // e.EncodeNil()
  1404. // return
  1405. // }
  1406. // if e.h.WriteExt {
  1407. // e.encodeExtPreamble(uint8(xtag), len(bs))
  1408. // e.w.writeb(bs)
  1409. // } else {
  1410. // e.EncodeStringBytesRaw(bs)
  1411. // }
  1412. // if ext == SelfExt {
  1413. // bufp.end()
  1414. // }
  1415. // }
  1416. // func encStringAsRawBytesMaybe(ee encDriver, s string, stringToRaw bool) {
  1417. // if stringToRaw {
  1418. // ee.EncodeStringBytesRaw(bytesView(s))
  1419. // } else {
  1420. // ee.EncodeStringEnc(cUTF8, s)
  1421. // }
  1422. // }