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