ns.go

   1 /*
   2 netstring -- netstring format serialization library
   3 Copyright (C) 2015-2021 Sergey Matveev <stargrave@stargrave.org>
   4
   5 This program is free software: you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation, version 3 of the License.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 // netstring format serialization library.
  19 //
  20 // This is implementation of netstring
  21 // (http://cr.yp.to/proto/netstrings.txt) format for binary string
  22 // serialization.
  23 //
  24 //   var b bytes.Buffer
  25 //   w := netstring.NewWriter(&b)
  26 //   n, _ = w.WriteChunk([]byte("hello")) // n is 8, "5:hello,"
  27 //   n, _ = w.WriteSize(6)                // n is 2
  28 //   n, _ = w.Write([]byte("wor"))        // n is 3
  29 //   n, _ = w.Write([]byte("ld!"))        // n is 3, "5:hello,6:world!,"
  30 //   r := netstring.NewReader(&b)
  31 //   size, err := r.Next()         // size is 5
  32 //   r.Discard()                   // skip that chunk
  33 //   size, err = r.Next()          // size is 6
  34 //   data, _ := ioutil.ReadAll(r)  // data contains "world!"
  35 package netstring