From 67e6da1861f08474219b8da56c2008615954a78e Mon Sep 17 00:00:00 2001 From: "snappy.mirrorbot@gmail.com" Date: Fri, 17 Aug 2012 13:54:47 +0000 Subject: 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: http://snappy.googlecode.com/svn/trunk@67 03e5f5b5-db94-4691-08a0-1a8bf15f6143 --- snappy.h | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'snappy.h') diff --git a/snappy.h b/snappy.h index 8c2075f..d15ffbf 100644 --- a/snappy.h +++ b/snappy.h @@ -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); // ------------------------------------------------------------------------ -- cgit v1.2.1