From 7d71bc590bc47bc44bff503694a0a82c82d5135f Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Thu, 8 Aug 2019 14:46:15 +1000 Subject: [PATCH] Add rac.Reader.CodecReaders doc comment --- lib/rac/reader.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/rac/reader.go b/lib/rac/reader.go index 67a5e875..6ee58ccd 100644 --- a/lib/rac/reader.go +++ b/lib/rac/reader.go @@ -55,6 +55,8 @@ type CodecReader interface { // Reader reads a RAC file. // // Do not modify its exported fields after calling any of its methods. +// +// Reader implements the io.ReadSeeker interface. type Reader struct { // ReadSeeker is where the RAC-encoded data is read from. // @@ -75,6 +77,10 @@ type Reader struct { // Zero is an invalid value, as an empty file is not a valid RAC file. CompressedSize int64 + // CodecReaders are the compression codecs that this Reader can decompress. + // + // For example, use a raczlib.CodecReader from the sibilng "raczlib" + // package. CodecReaders []CodecReader // err is the first error encountered. It is sticky: once a non-nil error