Fix public issue 66: Document GetUncompressedLength better, in particular that

it leaves the source in a state that's not appropriate for RawUncompress.

R=sanjay


git-svn-id: https://snappy.googlecode.com/svn/trunk@67 03e5f5b5-db94-4691-08a0-1a8bf15f6143
This commit is contained in:
snappy.mirrorbot@gmail.com
2012-08-17 13:54:47 +00:00
parent 2e225ba821
commit b86e81c8b3

View File

@@ -56,6 +56,13 @@ namespace snappy {
// number of bytes written.
size_t Compress(Source* source, Sink* sink);
// Find the uncompressed length of the given stream, as given by the header.
// Note that the true length could deviate from this; the stream could e.g.
// be truncated.
//
// Also note that this leaves "*source" in a state that is unsuitable for
// further operations, such as RawUncompress(). You will need to rewind
// or recreate the source yourself before attempting any further calls.
bool GetUncompressedLength(Source* source, uint32* result);
// ------------------------------------------------------------------------