summaryrefslogtreecommitdiff
path: root/snappy.h
diff options
context:
space:
mode:
Diffstat (limited to 'snappy.h')
-rw-r--r--snappy.h7
1 files changed, 7 insertions, 0 deletions
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);
// ------------------------------------------------------------------------