diff options
Diffstat (limited to 'Zip/Extra/Base.html')
| -rw-r--r-- | Zip/Extra/Base.html | 401 |
1 files changed, 401 insertions, 0 deletions
diff --git a/Zip/Extra/Base.html b/Zip/Extra/Base.html new file mode 100644 index 0000000..fc9fcc9 --- /dev/null +++ b/Zip/Extra/Base.html @@ -0,0 +1,401 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8" /> + <meta id="repository-name" content="github.com/pablotron/zip-crystal"> + <link href="../../css/style.css" rel="stylesheet" type="text/css" /> + <script type="text/javascript" src="../../js/doc.js"></script> + <title>Zip::Extra::Base - github.com/pablotron/zip-crystal</title> +</head> +<body> + +<div id="types-list"> + <div id="search-box"> + <input type="search" id="search-input" placeholder="Search..."> + </div> + + <ul> + <li><a href="../../index.html">README</a></li> + </ul> + + <ul> + + <li class="parent open current" data-id="github.com/pablotron/zip-crystal/Zip" data-name="zip"> + <a href="../../Zip.html">Zip</a> + + <ul> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Archive" data-name="zip::archive"> + <a href="../../Zip/Archive.html">Archive</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/CompressionMethod" data-name="zip::compressionmethod"> + <a href="../../Zip/CompressionMethod.html">CompressionMethod</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/DeflateCompressionHelper" data-name="zip::deflatecompressionhelper"> + <a href="../../Zip/DeflateCompressionHelper.html">DeflateCompressionHelper</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Entry" data-name="zip::entry"> + <a href="../../Zip/Entry.html">Entry</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Error" data-name="zip::error"> + <a href="../../Zip/Error.html">Error</a> + + </li> + + <li class="parent open current" data-id="github.com/pablotron/zip-crystal/Zip/Extra" data-name="zip::extra"> + <a href="../../Zip/Extra.html">Extra</a> + + <ul> + + <li class=" current" data-id="github.com/pablotron/zip-crystal/Zip/Extra/Base" data-name="zip::extra::base"> + <a href="../../Zip/Extra/Base.html">Base</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Extra/Zip64" data-name="zip::extra::zip64"> + <a href="../../Zip/Extra/Zip64.html">Zip64</a> + + </li> + +</ul> + + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/GeneralFlags" data-name="zip::generalflags"> + <a href="../../Zip/GeneralFlags.html">GeneralFlags</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/NoneCompressionHelper" data-name="zip::nonecompressionhelper"> + <a href="../../Zip/NoneCompressionHelper.html">NoneCompressionHelper</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Source" data-name="zip::source"> + <a href="../../Zip/Source.html">Source</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/TimeHelper" data-name="zip::timehelper"> + <a href="../../Zip/TimeHelper.html">TimeHelper</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Version" data-name="zip::version"> + <a href="../../Zip/Version.html">Version</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Writer" data-name="zip::writer"> + <a href="../../Zip/Writer.html">Writer</a> + + </li> + + <li class="parent " data-id="github.com/pablotron/zip-crystal/Zip/Writers" data-name="zip::writers"> + <a href="../../Zip/Writers.html">Writers</a> + + <ul> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Writers/DirEntry" data-name="zip::writers::direntry"> + <a href="../../Zip/Writers/DirEntry.html">DirEntry</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Writers/FileEntry" data-name="zip::writers::fileentry"> + <a href="../../Zip/Writers/FileEntry.html">FileEntry</a> + + </li> + + <li class=" " data-id="github.com/pablotron/zip-crystal/Zip/Writers/WriterEntry" data-name="zip::writers::writerentry"> + <a href="../../Zip/Writers/WriterEntry.html">WriterEntry</a> + + </li> + +</ul> + + + </li> + +</ul> + + + </li> + +</ul> + +</div> + +<div id="main-content"> +<h1 class="type-name"> + + <span class="kind">class</span> Zip::Extra::Base + +</h1> + + + <ul class="superclass-hierarchy"><li class="superclass"><a href="../../Zip/Extra/Base.html">Zip::Extra::Base</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul> + + + + + <h2>Overview</h2> + + <p>Raw extra data associated with <code><a href="../../Zip/Entry.html">Entry</a></code>.</p> + +<p>You should not need to instantiate this class directly; use +<code><a href="../../Zip/Entry.html#extras%3AArray%28Zip%3A%3AExtra%3A%3ABase%29-instance-method">Zip::Entry#extras</a></code> or <code><a href="../../Zip/Entry.html#local_extras%3AArray%28Extra%3A%3ABase%29-instance-method">Zip::Entry#local_extras</a></code> instead.</p> + +<p>Example:</p> + +<pre><code><span class="c"># open "foo.zip"</span> +<span class="t">Zip</span>.read(<span class="s">"foo.zip"</span>) <span class="k">do</span> <span class="o">|</span>zip<span class="o">|</span> + <span class="c"># get extra data associated with "bar.txt"</span> + extras <span class="o">=</span> zip[<span class="s">"bar.txt"</span>].extras +<span class="k">end</span></code></pre> + + + + + + + + + + <h2>Direct Known Subclasses</h2> + <ul class="other-types-list"> + + <li class="other-type"><a href="../../Zip/Extra/Zip64.html">Zip::Extra::Zip64</a></li> + + </ul> + + + + + + + <h2>Defined in:</h2> + + + + + + + <h2>Class Method Summary</h2> + <ul class="list-summary"> + + <li class="entry-summary"> + <a href="#new%28code%3AUInt16%2Cdata%3ABytes%29-class-method" class="signature"><strong>.new</strong>(code : UInt16, data : Bytes)</a> + + <div class="summary"><p>Create a new raw extra data entry.</p></div> + + </li> + + </ul> + + + + <h2>Instance Method Summary</h2> + <ul class="list-summary"> + + <li class="entry-summary"> + <a href="#bytes_needed%3AUInt16-instance-method" class="signature"><strong>#bytes_needed</strong> : UInt16</a> + + <div class="summary"><p>Return number of bytes needed for this Extra.</p></div> + + </li> + + <li class="entry-summary"> + <a href="#code%3AUInt16-instance-method" class="signature"><strong>#code</strong> : UInt16</a> + + <div class="summary"><p>Identifier for this extra entry.</p></div> + + </li> + + <li class="entry-summary"> + <a href="#code%3D%28code%29-instance-method" class="signature"><strong>#code=</strong>(code)</a> + + <div class="summary"><p>Identifier for this extra entry.</p></div> + + </li> + + <li class="entry-summary"> + <a href="#data%3ASlice%28UInt8%29-instance-method" class="signature"><strong>#data</strong> : Slice(UInt8)</a> + + <div class="summary"><p>Data for this extra entry.</p></div> + + </li> + + <li class="entry-summary"> + <a href="#data%3D%28data%29-instance-method" class="signature"><strong>#data=</strong>(data)</a> + + <div class="summary"><p>Data for this extra entry.</p></div> + + </li> + + <li class="entry-summary"> + <a href="#to_s%28io%29%3AUInt16-instance-method" class="signature"><strong>#to_s</strong>(io) : UInt16</a> + + </li> + + </ul> + + + + + +<div class="methods-inherited"> + + + + + + + + + + + + + + + +</div> + + + <h2>Class Method Detail</h2> + + <div class="entry-detail" id="new(code:UInt16,data:Bytes)-class-method"> + <div class="signature"> + + def self.<strong>new</strong>(code : UInt16, data : Bytes) + + <a class="method-permalink" href="#new%28code%3AUInt16%2Cdata%3ABytes%29-class-method">#</a> + </div> + + <div class="doc"><p>Create a new raw extra data entry.</p> + +<p>You should not need to instantiate this class directly; it is +created as-needed by <code><a href="../../Zip/Writer.html#add%28path%3AString%2Cio%3AIO%2Cmethod%3ACompressionMethod%3D%3Cspanclass%3D%22t%22%3ECompressionMethod%3C%2Fspan%3E%3Cspanclass%3D%22t%22%3E%3A%3A%3C%2Fspan%3E%3Cspanclass%3D%22t%22%3EDEFLATE%3C%2Fspan%3E%2Ctime%3ATime%3D%3Cspanclass%3D%22t%22%3ETime%3C%2Fspan%3E.now%2Ccomment%3AString%3D%3Cspanclass%3D%22s%22%3E%26quot%3B%26quot%3B%3C%2Fspan%3E%2Czip64%3ABool%3D%3Cspanclass%3D%22n%22%3Efalse%3C%2Fspan%3E%29%3AUInt64-instance-method">Writer#add</a></code>.</p></div> + + <br/> + <div> + + </div> + </div> + + + + + <h2>Instance Method Detail</h2> + + <div class="entry-detail" id="bytes_needed:UInt16-instance-method"> + <div class="signature"> + + def <strong>bytes_needed</strong> : UInt16 + + <a class="method-permalink" href="#bytes_needed%3AUInt16-instance-method">#</a> + </div> + + <div class="doc"><p>Return number of bytes needed for this Extra.</p></div> + + <br/> + <div> + + </div> + </div> + + <div class="entry-detail" id="code:UInt16-instance-method"> + <div class="signature"> + + def <strong>code</strong> : UInt16 + + <a class="method-permalink" href="#code%3AUInt16-instance-method">#</a> + </div> + + <div class="doc"><p>Identifier for this extra entry.</p></div> + + <br/> + <div> + + </div> + </div> + + <div class="entry-detail" id="code=(code)-instance-method"> + <div class="signature"> + + def <strong>code=</strong>(code) + + <a class="method-permalink" href="#code%3D%28code%29-instance-method">#</a> + </div> + + <div class="doc"><p>Identifier for this extra entry.</p></div> + + <br/> + <div> + + </div> + </div> + + <div class="entry-detail" id="data:Slice(UInt8)-instance-method"> + <div class="signature"> + + def <strong>data</strong> : Slice(UInt8) + + <a class="method-permalink" href="#data%3ASlice%28UInt8%29-instance-method">#</a> + </div> + + <div class="doc"><p>Data for this extra entry.</p></div> + + <br/> + <div> + + </div> + </div> + + <div class="entry-detail" id="data=(data)-instance-method"> + <div class="signature"> + + def <strong>data=</strong>(data) + + <a class="method-permalink" href="#data%3D%28data%29-instance-method">#</a> + </div> + + <div class="doc"><p>Data for this extra entry.</p></div> + + <br/> + <div> + + </div> + </div> + + <div class="entry-detail" id="to_s(io):UInt16-instance-method"> + <div class="signature"> + + def <strong>to_s</strong>(io) : UInt16 + + <a class="method-permalink" href="#to_s%28io%29%3AUInt16-instance-method">#</a> + </div> + + <br/> + <div> + + </div> + </div> + + + + + +</div> + +</body> +</html> |