Improve docs

service/rawdatastore/serialize_test.go

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package rawdatastore
 
 import (
         "bytes"
         "io"
         "testing"
@@ skipping 63 matching lines @@
                         },
                 },
         }
 
         Convey("PropertyMap serialization", t, func() {
                 Convey("round trip", func() {
                         for _, tc := range tests {
                                 tc := tc
                                 Convey(tc.name, func() {
                                         buf := &bytes.Buffer{}
-                                        WritePropertyMap(buf, tc.props, WithContext)
-                                        dec, err := ReadPropertyMap(buf, WithContext, "", "")
+                                        tc.props.Write(buf, WithContext)
+                                        dec := PropertyMap{}
+                                        err := dec.Read(buf, WithContext, "", "")
                                         So(err, ShouldBeNil)
                                         So(dec, ShouldResemble, tc.props)
                                 })
                         }
                 })
         })
 }
 
 func TestSerializationReadMisc(t *testing.T) {
         t.Parallel()
@@ skipping 125 matching lines @@
                                         cmpbin.WriteString(buf, "hi")
                                         buf.WriteByte(byte(PTInt))
                                         cmpbin.WriteInt(buf, -2)
                                         _, err := ReadKey(buf, WithContext, "", "")
                                         So(err, ShouldErrLike, "zero/negative")
                                 })
                         })
                 })
 
                 Convey("ReadGeoPoint", func() {
+                        gp := GeoPoint{}
                         Convey("trunc 1", func() {
-                                _, err := ReadGeoPoint(buf)
+                                err := gp.Read(buf)
                                 So(err, ShouldEqual, io.EOF)
                         })
                         Convey("trunc 2", func() {
                                 cmpbin.WriteFloat64(buf, 100)
-                                _, err := ReadGeoPoint(buf)
+                                err := gp.Read(buf)
                                 So(err, ShouldEqual, io.EOF)
                         })
                         Convey("invalid", func() {
                                 cmpbin.WriteFloat64(buf, 100)
                                 cmpbin.WriteFloat64(buf, 1000)
-                                _, err := ReadGeoPoint(buf)
+                                err := gp.Read(buf)
                                 So(err, ShouldErrLike, "invalid GeoPoint")
                         })
                 })
 
                 Convey("WriteTime", func() {
                         Convey("in non-UTC!", func() {
                                 pst, err := time.LoadLocation("America/Los_Angeles")
                                 So(err, ShouldBeNil)
                                 So(func() {
                                         WriteTime(buf, time.Now().In(pst))
                                 }, ShouldPanic)
                         })
                 })
 
                 Convey("ReadTime", func() {
                         Convey("trunc 1", func() {
                                 _, err := ReadTime(buf)
                                 So(err, ShouldEqual, io.EOF)
                         })
                 })
 
                 Convey("ReadProperty", func() {
+                        p := Property{}
                         Convey("trunc 1", func() {
-                                _, err := ReadProperty(buf, WithContext, "", "")
+                                err := p.Read(buf, WithContext, "", "")
                                 So(err, ShouldEqual, io.EOF)
+                                So(p.Type(), ShouldEqual, PTNull)
+                                So(p.Value(), ShouldBeNil)
                         })
                         Convey("trunc (PTBytes)", func() {
                                 buf.WriteByte(byte(PTBytes))
-                                _, err := ReadProperty(buf, WithContext, "", "")
+                                err := p.Read(buf, WithContext, "", "")
                                 So(err, ShouldEqual, io.EOF)
                         })
                         Convey("trunc (PTBlobKey)", func() {
                                 buf.WriteByte(byte(PTBlobKey))
-                                _, err := ReadProperty(buf, WithContext, "", "")
+                                err := p.Read(buf, WithContext, "", "")
                                 So(err, ShouldEqual, io.EOF)
                         })
                         Convey("invalid type", func() {
                                 buf.WriteByte(byte(PTUnknown + 1))
-                                _, err := ReadProperty(buf, WithContext, "", "")
+                                err := p.Read(buf, WithContext, "", "")
                                 So(err, ShouldErrLike, "unknown type!")
                         })
                 })
 
                 Convey("ReadPropertyMap", func() {
+                        pm := PropertyMap{}
                         Convey("trunc 1", func() {
-                                _, err := ReadPropertyMap(buf, WithContext, "", "")
+                                err := pm.Read(buf, WithContext, "", "")
                                 So(err, ShouldEqual, io.EOF)
                         })
                         Convey("too many rows", func() {
                                 cmpbin.WriteUint(buf, 1000000)
-                                _, err := ReadPropertyMap(buf, WithContext, "", "")
+                                err := pm.Read(buf, WithContext, "", "")
                                 So(err, ShouldErrLike, "huge number of rows")
                         })
                         Convey("trunc 2", func() {
                                 cmpbin.WriteUint(buf, 10)
-                                _, err := ReadPropertyMap(buf, WithContext, "", "")
+                                err := pm.Read(buf, WithContext, "", "")
                                 So(err, ShouldEqual, io.EOF)
                         })
                         Convey("trunc 3", func() {
                                 cmpbin.WriteUint(buf, 10)
                                 cmpbin.WriteString(buf, "ohai")
-                                _, err := ReadPropertyMap(buf, WithContext, "", "")
+                                err := pm.Read(buf, WithContext, "", "")
                                 So(err, ShouldEqual, io.EOF)
                         })
                         Convey("too many values", func() {
                                 cmpbin.WriteUint(buf, 10)
                                 cmpbin.WriteString(buf, "ohai")
                                 cmpbin.WriteUint(buf, 100000)
-                                _, err := ReadPropertyMap(buf, WithContext, "", "")
+                                err := pm.Read(buf, WithContext, "", "")
                                 So(err, ShouldErrLike, "huge number of properties")
                         })
                         Convey("trunc 4", func() {
                                 cmpbin.WriteUint(buf, 10)
                                 cmpbin.WriteString(buf, "ohai")
                                 cmpbin.WriteUint(buf, 10)
-                                _, err := ReadPropertyMap(buf, WithContext, "", "")
+                                err := pm.Read(buf, WithContext, "", "")
                                 So(err, ShouldEqual, io.EOF)
                         })
                 })
         })
 }