github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/encoding/proto/docs/README.md (about)

     1  # Protobuf Encoding
     2  
     3  ## Overview
     4  
     5  This package contains the encoder/decoder for compressing streams of Protobuf messages matching a provided schema.
     6  
     7  All compression is performed in an unbuffered manner such that the encoded stream is updated with each write; there is no internal buffering or batching during which multiple writes are gathered before performing encoding.
     8  
     9  Read [encoding.md](./encoding.md) for details on the encoding scheme.
    10  Read [unmarshal.md](./unmarshal.md) for details on the custom dynamic Protobuf unmarshaller.
    11  Read [marshal.md](./marshal.md) for details on the custom dynamic Protobuf marshaller.