{"payload":{"allShortcutsEnabled":false,"fileTree":{"":{"items":[{"name":"README.md","path":"README.md","contentType":"file"},{"name":"deflate.cl","path":"deflate.cl","contentType":"file"},{"name":"deflate.txt","path":"deflate.txt","contentType":"file"},{"name":"inflate.cl","path":"inflate.cl","contentType":"file"},{"name":"makefile","path":"makefile","contentType":"file"},{"name":"t-gzip.cl","path":"t-gzip.cl","contentType":"file"},{"name":"t-iperf.cl","path":"t-iperf.cl","contentType":"file"}],"totalCount":7}},"fileTreeProcessingTime":5.758977,"foldersToFetch":[],"repo":{"id":216789,"defaultBranch":"master","name":"zlib","ownerLogin":"franzinc","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2009-06-02T20:13:01.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/84627?v=4","public":true,"private":false,"isOrgOwned":false},"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"install-aws_2012-05-08T15-26-08","listCacheKey":"v0:1700495369.0","canEdit":false,"refType":"tag","currentOid":"12a11c827f8b99ef27812ebdb51ea8134cc537de"},"path":"deflate.txt","currentUser":null,"blob":{"rawLines":["","deflate module documentation","","[this is temporary until the documentation is property formatted","and merged with other documentation]","","","The deflate module provides a stream interface to the widely","available libz compression library. libz is not included and is","assumee to be on your machine.","","","","","","Functions are in the util.zip package.","The module exports","","class:"," deflate-stream","","functions"," deflate-target-stream"," deflate-stream-vector"," deflate-stream-vector-combined","","",""," ","","","This module implements the deflate-stream. A deflate-stream","accepts characters and byte and causes them to be compressed","and sent to a target.","","The target can either another stream, or it can be a vector.","In the case of a vector the deflate-stream will collect the","complete deflation of what is written to it in a sequence of","vectors, initially using the vector passed in as the target and","then allocating new vectors as necessary.","","Usage:","(make-instance 'deflate-stream :target target-spec :compression compress-spec)","","The target-spec is a stream or a simple vector element type (unsigned-byte 8).","","The compress-spec is either :gzip or :deflate (where :gzip is the default).","",":gzip is the preferred format as the result can be uncompressed with","the inflate-stream (be sure to specify :skip-gzip-header t to the","make-instance of inflate-stream). The :gzip format output can","also be uncompressed with the gunzip program fount on Unix.","","","","","","Stream as a target-spec","","If you pass a stream as the target-spec then as you write characters","and bytes to the deflate-stream, the bytes resulting from deflation","will be written to the given stream. There is a lot of buffering","going on in this stream and the compression library. Therefore you","may not see the results in your target-spec stream immeidately.","","When you close the deflate-stream the last bytes in all the buffers","will be sent through deflation and the end of deflation record will","be written to the target-spec stream.","","The target-spec stream will NOT be closed. It is the callers responsibility","to close the stream passed in as the target-spec","","","The function","(deflate-target-stream deflate-stream)","","will return that target-spec stream used by the deflate-stream","","","",";","","","Octet vector as a target-spec","","Passing a simple vector of type (unsigned-byte 8) as the target-spec","is telling the deflate-stream that you wish to collect the deflation","result in vectors in the lisp heap.","","After you close the deflate-stream you can retrieve the result of","deflation in one of two ways:","","","","(deflate-stream-vector-combined deflate-stream)","","returns two values"," 1. octet vector"," 2. number of bytes of actual data","","this says that the result of deflation is found in the first N bytes","of the vector returned by the first value. The second value returned is N.","","","","","","(deflate-stream-vector deflate-stream)","","returns three values"," 1. the newest vector"," 2. the number of byte of actual data in the newest vector"," 3. a list of previous vectors holding data in reverse order","","for example if the three returned values were",""," v"," 100"," (c b a)","","then the deflated result is found by combining in this order:"," all of a"," all of b"," all of c"," the first 100 bytes of v","","The deflate-stream-vector-combined function does the combination","described above to produce its results. This results in","a new vector allocation and then copying that wouldn't be necessary","if you're prepared to work with the raw results from deflate-stream-vector","",""," "],"stylingDirectives":[[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[],[]],"colorizedLines":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/franzinc/zlib/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null},"displayName":"deflate.txt","displayUrl":"https://github.com/franzinc/zlib/blob/install-aws_2012-05-08T15-26-08/deflate.txt?raw=true","headerInfo":{"blobSize":"3.4 KB","deleteTooltip":"You must be signed in to make or propose changes","editTooltip":"You must be signed in to make or propose changes","ghDesktopPath":null,"isGitLfs":false,"onBranch":false,"shortPath":"b46b97a","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Ffranzinc%2Fzlib%2Fblob%2Finstall-aws_2012-05-08T15-26-08%2Fdeflate.txt","isCSV":false,"isRichtext":false,"toc":null,"lineInfo":{"truncatedLoc":"139","truncatedSloc":"75"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplate":null,"discussionTemplate":null,"language":"Text","languageID":372,"large":false,"planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/franzinc/zlib/blob/install-aws_2012-05-08T15-26-08/deflate.txt","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","releasePath":"/franzinc/zlib/releases/new?marketplace=true","showPublishActionBanner":false},"rawBlobUrl":"https://github.com/franzinc/zlib/raw/install-aws_2012-05-08T15-26-08/deflate.txt","renderImageOrRaw":false,"richText":null,"renderedFileInfo":null,"shortPath":null,"symbolsEnabled":true,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timed_out":false,"not_analyzed":true,"symbols":[]}},"copilotInfo":null,"copilotAccessAllowed":false,"csrf_tokens":{"/franzinc/zlib/branches":{"post":"qe-LTSUddRNtc3C8FKZPCofGIcZv_ese19kkGRxA8wcyCCEIW1Cz8F5qNDmyIb4f1FmVyxAdJzgrJwkRXPJc6g"},"/repos/preferences":{"post":"X8aC9n2cNp83-d2Nf9d-nBfVze_-piGo3HLze-uWFFrobcnjWkEghDSw2fGKBK90DtXYnh_f0vsK40ZUPpUhKQ"}}},"title":"zlib/deflate.txt at install-aws_2012-05-08T15-26-08 ยท franzinc/zlib"}