diff options
| author | Paul Duncan <pabs@pablotron.org> | 2016-08-11 00:30:34 -0400 |
|---|---|---|
| committer | Paul Duncan <pabs@pablotron.org> | 2016-08-11 00:30:34 -0400 |
| commit | d64ce278f01cafc1c3c23aec9bb2394412ad160b (patch) | |
| tree | 8a089d44a15dbef0a2ba14c649e82120716ccb72 /Zip/WriterEntry.html | |
| parent | 055abed0e28681387377671bc16d40d075e3aaf7 (diff) | |
| download | zip-crystal-d64ce278f01cafc1c3c23aec9bb2394412ad160b.tar.bz2 zip-crystal-d64ce278f01cafc1c3c23aec9bb2394412ad160b.zip | |
update documentation
Diffstat (limited to 'Zip/WriterEntry.html')
| -rw-r--r-- | Zip/WriterEntry.html | 319 |
1 files changed, 0 insertions, 319 deletions
diff --git a/Zip/WriterEntry.html b/Zip/WriterEntry.html deleted file mode 100644 index 843b04b..0000000 --- a/Zip/WriterEntry.html +++ /dev/null @@ -1,319 +0,0 @@ -<!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::WriterEntry - 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=" " data-id="github.com/pablotron/zip-crystal/Zip/Extra" data-name="zip::extra"> - <a href="../Zip/Extra.html">Extra</a> - - </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=" current" data-id="github.com/pablotron/zip-crystal/Zip/WriterEntry" data-name="zip::writerentry"> - <a href="../Zip/WriterEntry.html">WriterEntry</a> - - </li> - -</ul> - - - </li> - -</ul> - -</div> - -<div id="main-content"> -<h1 class="type-name"> - - <span class="kind">class</span> Zip::WriterEntry - -</h1> - - - <ul class="superclass-hierarchy"><li class="superclass"><a href="../Zip/WriterEntry.html">Zip::WriterEntry</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul> - - - - - <h2>Overview</h2> - - <p>Internal class used to store files for <code><a href="../Zip/Writer.html">Writer</a></code> instance.</p> - -<p>You should not need to instantiate this class directly; it is called -automatically 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%29%3AUInt32-instance-method">Writer#add</a></code> and <code><a href="../Zip/Writer.html#add_file%28path%3AString%2Cfile_path%3AString%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%29%3AUInt32-instance-method">Writer#add_file</a></code>.</p> - - - - - - <h2>Included Modules</h2> - <ul class="other-types-list"> - - <li class="other-type"><a href="../Zip/DeflateCompressionHelper.html">Zip::DeflateCompressionHelper</a></li> - - <li class="other-type"><a href="../Zip/NoneCompressionHelper.html">Zip::NoneCompressionHelper</a></li> - - <li class="other-type"><a href="../Zip/TimeHelper.html">Zip::TimeHelper</a></li> - - </ul> - - - - - - - - - - - <h2>Defined in:</h2> - - - - - - <h2>Constant Summary</h2> - - <dl> - - <dt class="entry-const" id="GENERAL_FLAGS"> - <strong>GENERAL_FLAGS</strong> = <code><span class="t">GeneralFlags</span>.flags(<span class="t">FOOTER</span>, <span class="t">EFS</span>)</code> - </dt> - - <dd class="entry-const-doc"> - <p>Default flags for local and central header.</p> - </dd> - - - </dl> - - - - <h2>Class Method Summary</h2> - <ul class="list-summary"> - - <li class="entry-summary"> - <a href="#new%28pos%3AUInt32%2Cpath%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%29-class-method" class="signature"><strong>.new</strong>(pos : UInt32, path : String, io : IO, method : CompressionMethod = <span class="t">CompressionMethod</span><span class="t">::</span><span class="t">DEFLATE</span>, time : Time = <span class="t">Time</span>.now, comment : String = <span class="s">""</span>)</a> - - <div class="summary"><p>Create a new WriterEntry instance.</p></div> - - </li> - - </ul> - - - - <h2>Instance Method Summary</h2> - <ul class="list-summary"> - - <li class="entry-summary"> - <a href="#to_s%28dst_io%29%3AUInt32-instance-method" class="signature"><strong>#to_s</strong>(dst_io) : UInt32</a> - - <div class="summary"><p>Write local file entry to IO and return the number of bytes written.</p></div> - - </li> - - <li class="entry-summary"> - <a href="#write_central%28io%3AIO%2Cversion%3AVersion%3D%3Cspanclass%3D%22t%22%3EVersion%3C%2Fspan%3E%3Cspanclass%3D%22t%22%3E%3A%3A%3C%2Fspan%3E%3Cspanclass%3D%22t%22%3EDEFAULT%3C%2Fspan%3E%29%3AUInt32-instance-method" class="signature"><strong>#write_central</strong>(io : IO, version : Version = <span class="t">Version</span><span class="t">::</span><span class="t">DEFAULT</span>) : UInt32</a> - - <div class="summary"><p>Write central directory data for this <code><a href="../Zip/WriterEntry.html">WriterEntry</a></code> and return the number of bytes written.</p></div> - - </li> - - </ul> - - - - - -<div class="methods-inherited"> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</div> - - - <h2>Class Method Detail</h2> - - <div class="entry-detail" id="new(pos:UInt32,path:String,io:IO,method:CompressionMethod=<spanclass="t">CompressionMethod</span><spanclass="t">::</span><spanclass="t">DEFLATE</span>,time:Time=<spanclass="t">Time</span>.now,comment:String=<spanclass="s">&quot;&quot;</span>)-class-method"> - <div class="signature"> - - def self.<strong>new</strong>(pos : UInt32, path : String, io : IO, method : <a href="../Zip/CompressionMethod.html">CompressionMethod</a> = <span class="t">CompressionMethod</span><span class="t">::</span><span class="t">DEFLATE</span>, time : Time = <span class="t">Time</span>.now, comment : String = <span class="s">""</span>) - - <a class="method-permalink" href="#new%28pos%3AUInt32%2Cpath%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%29-class-method">#</a> - </div> - - <div class="doc"><p>Create a new WriterEntry instance.</p> - -<p>You should not need to call this method directly; it is called -automatically 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%29%3AUInt32-instance-method">Writer#add</a></code> and <code><a href="../Zip/Writer.html#add_file%28path%3AString%2Cfile_path%3AString%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%29%3AUInt32-instance-method">Writer#add_file</a></code>.</p></div> - - <br/> - <div> - - </div> - </div> - - - - - <h2>Instance Method Detail</h2> - - <div class="entry-detail" id="to_s(dst_io):UInt32-instance-method"> - <div class="signature"> - - def <strong>to_s</strong>(dst_io) : UInt32 - - <a class="method-permalink" href="#to_s%28dst_io%29%3AUInt32-instance-method">#</a> - </div> - - <div class="doc"><p>Write local file entry to IO and return the number of bytes -written.</p> - -<p>You should not need to call this method directly; it is called -automatically 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%29%3AUInt32-instance-method">Writer#add</a></code> and <code><a href="../Zip/Writer.html#add_file%28path%3AString%2Cfile_path%3AString%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%29%3AUInt32-instance-method">Writer#add_file</a></code>.</p></div> - - <br/> - <div> - - </div> - </div> - - <div class="entry-detail" id="write_central(io:IO,version:Version=<spanclass="t">Version</span><spanclass="t">::</span><spanclass="t">DEFAULT</span>):UInt32-instance-method"> - <div class="signature"> - - def <strong>write_central</strong>(io : IO, version : <a href="../Zip/Version.html">Version</a> = <span class="t">Version</span><span class="t">::</span><span class="t">DEFAULT</span>) : UInt32 - - <a class="method-permalink" href="#write_central%28io%3AIO%2Cversion%3AVersion%3D%3Cspanclass%3D%22t%22%3EVersion%3C%2Fspan%3E%3Cspanclass%3D%22t%22%3E%3A%3A%3C%2Fspan%3E%3Cspanclass%3D%22t%22%3EDEFAULT%3C%2Fspan%3E%29%3AUInt32-instance-method">#</a> - </div> - - <div class="doc"><p>Write central directory data for this <code><a href="../Zip/WriterEntry.html">WriterEntry</a></code> and return the -number of bytes written.</p> - -<p>You should not need to call this method directly; it is called -automatically by <code><a href="../Zip/Writer.html#close-instance-method">Writer#close</a></code>.</p></div> - - <br/> - <div> - - </div> - </div> - - - - - -</div> - -</body> -</html> |