summaryrefslogtreecommitdiff
path: root/devdocs/go/compress%2Fbzip2%2Findex.html
blob: 523f71cb79598697ef06cd20f921bd63837af466 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<h1> Package bzip2  </h1>     <ul id="short-nav">
<li><code>import "compress/bzip2"</code></li>
<li><a href="#pkg-overview" class="overviewLink">Overview</a></li>
<li><a href="#pkg-index" class="indexLink">Index</a></li>
</ul>     <h2 id="pkg-overview">Overview </h2> <p>Package bzip2 implements bzip2 decompression. </p>     <h2 id="pkg-index">Index </h2>  <ul id="manual-nav">
<li><a href="#NewReader">func NewReader(r io.Reader) io.Reader</a></li>
<li><a href="#StructuralError">type StructuralError</a></li>
<li> <a href="#StructuralError.Error">func (s StructuralError) Error() string</a>
</li>
</ul> <h3>Package files</h3> <p>  <span>bit_reader.go</span> <span>bzip2.go</span> <span>huffman.go</span> <span>move_to_front.go</span>  </p>   <h2 id="NewReader">func <span>NewReader</span>  </h2> <pre data-language="go">func NewReader(r io.Reader) io.Reader</pre> <p>NewReader returns an io.Reader which decompresses bzip2 data from r. If r does not also implement <span>io.ByteReader</span>, the decompressor may read more data than necessary from r. </p>
<h2 id="StructuralError">type <span>StructuralError</span>  </h2> <p>A StructuralError is returned when the bzip2 data is found to be syntactically invalid. </p>
<pre data-language="go">type StructuralError string</pre> <h3 id="StructuralError.Error">func (StructuralError) <span>Error</span>  </h3> <pre data-language="go">func (s StructuralError) Error() string</pre><div class="_attribution">
  <p class="_attribution-p">
    &copy; Google, Inc.<br>Licensed under the Creative Commons Attribution License 3.0.<br>
    <a href="http://golang.org/pkg/compress/bzip2/" class="_attribution-link">http://golang.org/pkg/compress/bzip2/</a>
  </p>
</div>