File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Package/TarWriter.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Package::TarWriter - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-add_file">#add_file</a>
<li ><a href="#method-i-add_file_digest">#add_file_digest</a>
<li ><a href="#method-i-add_file_signed">#add_file_signed</a>
<li ><a href="#method-i-add_file_simple">#add_file_simple</a>
<li ><a href="#method-i-add_symlink">#add_symlink</a>
<li ><a href="#method-i-check_closed">#check_closed</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-closed-3F">#closed?</a>
<li ><a href="#method-i-flush">#flush</a>
<li ><a href="#method-i-mkdir">#mkdir</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Package::TarWriter">
<h1 id="class-Gem::Package::TarWriter" class="class">
class Gem::Package::TarWriter
</h1>
<section class="description">
<p>Allows writing of tar files</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(io)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="TarWriter.html"><code>TarWriter</code></a> that will write to <code>io</code></p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 96</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">io</span>)
<span class="ruby-ivar">@io</span> = <span class="ruby-identifier">io</span>
<span class="ruby-ivar">@closed</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(io) { |writer| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="TarWriter.html"><code>TarWriter</code></a>, yielding it if a block is given</p>
<div class="method-calls-super">
Calls superclass method
<a href="../../BasicObject.html#method-c-new"><code>BasicObject::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">io</span>)
<span class="ruby-identifier">writer</span> = <span class="ruby-keyword">super</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">writer</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">writer</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">writer</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-add_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_file</span><span
class="method-args">(name, mode) { |io| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds file <code>name</code> with permissions <code>mode</code>, and yields an <a href="../../IO.html"><code>IO</code></a> for writing the file to</p>
<div class="method-source-code" id="add_file-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 105</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_file</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">mode</span>) <span class="ruby-comment"># :yields: io</span>
<span class="ruby-identifier">check_closed</span>
<span class="ruby-identifier">name</span>, <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">split_name</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">init_pos</span> = <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">pos</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">TarHeader</span><span class="ruby-operator">::</span><span class="ruby-constant">EMPTY_HEADER</span> <span class="ruby-comment"># placeholder for the header</span>
<span class="ruby-keyword">yield</span> <span class="ruby-constant">RestrictedStream</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@io</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">size</span> = <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">pos</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">init_pos</span> <span class="ruby-operator">-</span> <span class="ruby-value">512</span>
<span class="ruby-identifier">remainder</span> = (<span class="ruby-value">512</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">size</span> <span class="ruby-operator">%</span> <span class="ruby-value">512</span>)) <span class="ruby-operator">%</span> <span class="ruby-value">512</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span> <span class="ruby-string">"\0"</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">remainder</span>
<span class="ruby-identifier">final_pos</span> = <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">pos</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">pos</span> = <span class="ruby-identifier">init_pos</span>
<span class="ruby-identifier">header</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">TarHeader</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">:name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-value">:mode</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mode</span>,
<span class="ruby-value">:size</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">size</span>, <span class="ruby-value">:prefix</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">prefix</span>,
<span class="ruby-value">:mtime</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">source_date_epoch</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">header</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">pos</span> = <span class="ruby-identifier">final_pos</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_file_digest" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_file_digest</span><span
class="method-args">(name, mode, digest_algorithms) { |io| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>name</code> with permissions <code>mode</code> to the tar, yielding <code>io</code> for writing the file. The <code>digest_algorithm</code> is written to a read-only <code>name</code>.sum file following the given file contents containing the digest name and hexdigest separated by a tab.</p>
<p>The created digest object is returned.</p>
<div class="method-source-code" id="add_file_digest-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 141</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_file_digest</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">mode</span>, <span class="ruby-identifier">digest_algorithms</span>) <span class="ruby-comment"># :yields: io</span>
<span class="ruby-identifier">digests</span> = <span class="ruby-identifier">digest_algorithms</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">digest_algorithm</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">digest</span> = <span class="ruby-identifier">digest_algorithm</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">digest_name</span> =
<span class="ruby-keyword">if</span> <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:name</span>
<span class="ruby-identifier">digest</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">else</span>
<span class="ruby-regexp">/::([^:]+)$/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">digest_algorithm</span>.<span class="ruby-identifier">name</span>
<span class="ruby-node">$1</span>
<span class="ruby-keyword">end</span>
[<span class="ruby-identifier">digest_name</span>, <span class="ruby-identifier">digest</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">digests</span> = <span class="ruby-constant">Hash</span>[<span class="ruby-operator">*</span><span class="ruby-identifier">digests</span>.<span class="ruby-identifier">flatten</span>]
<span class="ruby-identifier">add_file</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">mode</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">DigestIO</span>.<span class="ruby-identifier">wrap</span> <span class="ruby-identifier">io</span>, <span class="ruby-identifier">digests</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">digest_io</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">digest_io</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">digests</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_file_signed" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_file_signed</span><span
class="method-args">(name, mode, signer) { |io| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>name</code> with permissions <code>mode</code> to the tar, yielding <code>io</code> for writing the file. The <code>signer</code> is used to add a digest file using its digest_algorithm per <a href="TarWriter.html#method-i-add_file_digest"><code>add_file_digest</code></a> and a cryptographic signature in <code>name</code>.sig. If the signer has no key only the checksum file is added.</p>
<p>Returns the digest.</p>
<div class="method-source-code" id="add_file_signed-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 174</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_file_signed</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">mode</span>, <span class="ruby-identifier">signer</span>)
<span class="ruby-identifier">digest_algorithms</span> = [
<span class="ruby-identifier">signer</span>.<span class="ruby-identifier">digest_algorithm</span>,
<span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA512</span>,
].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">uniq</span>
<span class="ruby-identifier">digests</span> = <span class="ruby-identifier">add_file_digest</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">mode</span>, <span class="ruby-identifier">digest_algorithms</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">io</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">signature_digest</span> = <span class="ruby-identifier">digests</span>.<span class="ruby-identifier">values</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">digest</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">digest_name</span> =
<span class="ruby-keyword">if</span> <span class="ruby-identifier">digest</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:name</span>
<span class="ruby-identifier">digest</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">digest</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>[<span class="ruby-regexp">/::([^:]+)\z/</span>, <span class="ruby-value">1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">digest_name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">signer</span>.<span class="ruby-identifier">digest_name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-node">"no #{signer.digest_name} in #{digests.values.compact}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">signature_digest</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">signer</span>.<span class="ruby-identifier">key</span>
<span class="ruby-identifier">signature</span> = <span class="ruby-identifier">signer</span>.<span class="ruby-identifier">sign</span> <span class="ruby-identifier">signature_digest</span>.<span class="ruby-identifier">digest</span>
<span class="ruby-identifier">add_file_simple</span> <span class="ruby-node">"#{name}.sig"</span>, <span class="ruby-value">0444</span>, <span class="ruby-identifier">signature</span>.<span class="ruby-identifier">length</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">signature</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">digests</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_file_simple" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_file_simple</span><span
class="method-args">(name, mode, size) { |io| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add file <code>name</code> with permissions <code>mode</code> <code>size</code> bytes long. Yields an <a href="../../IO.html"><code>IO</code></a> to write the file to.</p>
<div class="method-source-code" id="add_file_simple-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 212</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_file_simple</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">mode</span>, <span class="ruby-identifier">size</span>) <span class="ruby-comment"># :yields: io</span>
<span class="ruby-identifier">check_closed</span>
<span class="ruby-identifier">name</span>, <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">split_name</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">header</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">TarHeader</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-value">:mode</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mode</span>,
<span class="ruby-value">:size</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">size</span>, <span class="ruby-value">:prefix</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">prefix</span>,
<span class="ruby-value">:mtime</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">source_date_epoch</span>).<span class="ruby-identifier">to_s</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">header</span>
<span class="ruby-identifier">os</span> = <span class="ruby-constant">BoundedStream</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@io</span>, <span class="ruby-identifier">size</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">os</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">min_padding</span> = <span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">os</span>.<span class="ruby-identifier">written</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span>(<span class="ruby-string">"\0"</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">min_padding</span>)
<span class="ruby-identifier">remainder</span> = (<span class="ruby-value">512</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">size</span> <span class="ruby-operator">%</span> <span class="ruby-value">512</span>)) <span class="ruby-operator">%</span> <span class="ruby-value">512</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span>(<span class="ruby-string">"\0"</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">remainder</span>)
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add_symlink" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_symlink</span><span
class="method-args">(name, target, mode)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds symlink <code>name</code> with permissions <code>mode</code>, linking to <code>target</code>.</p>
<div class="method-source-code" id="add_symlink-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 238</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_symlink</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">target</span>, <span class="ruby-identifier">mode</span>)
<span class="ruby-identifier">check_closed</span>
<span class="ruby-identifier">name</span>, <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">split_name</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">header</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">TarHeader</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-value">:mode</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mode</span>,
<span class="ruby-value">:size</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>, <span class="ruby-value">:typeflag</span> <span class="ruby-operator">=></span> <span class="ruby-string">"2"</span>,
<span class="ruby-value">:linkname</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">target</span>,
<span class="ruby-value">:prefix</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">prefix</span>,
<span class="ruby-value">:mtime</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">source_date_epoch</span>).<span class="ruby-identifier">to_s</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">header</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-check_closed" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_closed</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Raises <a href="../../IOError.html"><code>IOError</code></a> if the <a href="TarWriter.html"><code>TarWriter</code></a> is closed</p>
<div class="method-source-code" id="check_closed-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 257</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_closed</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-node">"closed #{self.class}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">closed?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Closes the <a href="TarWriter.html"><code>TarWriter</code></a></p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 264</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-identifier">check_closed</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span> <span class="ruby-string">"\0"</span> <span class="ruby-operator">*</span> <span class="ruby-value">1024</span>
<span class="ruby-identifier">flush</span>
<span class="ruby-ivar">@closed</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-closed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">closed?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Is the <a href="TarWriter.html"><code>TarWriter</code></a> closed?</p>
<div class="method-source-code" id="closed-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 276</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>
<span class="ruby-ivar">@closed</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-flush" class="method-detail ">
<div class="method-heading">
<span class="method-name">flush</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Flushes the TarWriter's <a href="../../IO.html"><code>IO</code></a></p>
<div class="method-source-code" id="flush-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 283</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flush</span>
<span class="ruby-identifier">check_closed</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">flush</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:flush</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mkdir" class="method-detail ">
<div class="method-heading">
<span class="method-name">mkdir</span><span
class="method-args">(name, mode)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new directory in the tar file <code>name</code> with <code>mode</code></p>
<div class="method-source-code" id="mkdir-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/tar_writer.rb, line 292</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mkdir</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">mode</span>)
<span class="ruby-identifier">check_closed</span>
<span class="ruby-identifier">name</span>, <span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">split_name</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">header</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">TarHeader</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">:name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">name</span>, <span class="ruby-value">:mode</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mode</span>,
<span class="ruby-value">:typeflag</span> <span class="ruby-operator">=></span> <span class="ruby-string">"5"</span>, <span class="ruby-value">:size</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
<span class="ruby-value">:prefix</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">prefix</span>,
<span class="ruby-value">:mtime</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">source_date_epoch</span>
<span class="ruby-ivar">@io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">header</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>