class Minitar::Output

Wraps a Minitar::Writer with convenience methods and wrapped stream management. If the stream provided to Output does not support random access, only Writer#add_file_simple and Writer#mkdir are guaranteed to work.

Attributes

tar[R]

Returns the Writer object for direct access.

Public Class Methods

Minitar::Output.new(io) → output click to toggle source
Minitar::Output.new(path) → output

Creates a new Output object. If output is a stream object that responds to write, then it will simply be wrapped. Otherwise, one will be created and opened using Kernel#open. When Output#close is called, the stream object wrapped will be closed.

# File lib/minitar/output.rb, line 54
def initialize(output)
  @io = if output.respond_to?(:write)
    output
  else
    ::Kernel.open(output, "wb")
  end
  @tar = Minitar::Writer.new(@io)
end
Minitar::Output.open(io) → output click to toggle source
Minitar::Output.open(io) { |output| block } → obj

With no associated block, Output.open is a synonym for Output.new. If the optional code block is given, it will be given the new Output as an argument and the Output object will automatically be closed when the block terminates (this also closes the wrapped stream object). In this instance, Output.open returns the value of the block.

# File lib/minitar/output.rb, line 18
def self.open(output)
  stream = new(output)
  return stream unless block_given?

  # This exception context must remain, otherwise the stream closes on open
  # even if a block is not given.
  begin
    yield stream
  ensure
    stream.close
  end
end
Minitar::Output.tar(io) → enumerator click to toggle source
Minitar::Output.tar(io) { |tar| block } → obj

Output.tar is a wrapper for Output.open that yields the owned tar object instead of the Output object. If a block is not provided, an enumerator will be created with the same behaviour.

# File lib/minitar/output.rb, line 38
def self.tar(output)
  return to_enum(__method__, output) unless block_given?

  Output.open(output) do |stream|
    yield stream.tar
  end
end

Public Instance Methods

close() click to toggle source

Closes the Writer object and the wrapped data stream.

# File lib/minitar/output.rb, line 72
def close
  @tar.close
  @io.close
end
closed?() click to toggle source

Returns false if the wrapped data stream is open.

# File lib/minitar/output.rb, line 67
def closed?
  @io.closed?
end