Ruby

Unzip One File to a Stream

See more Zip Examples

Demonstrates how to unzip a particular file contained within a .zip archive to a Chilkat stream. Ruby

require 'chilkat'

success = false

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

zip = Chilkat::CkZip.new()

# First open a .zip.
success = zip.OpenZip("qa_data/hamlet.zip")
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

# Find the entry to be unzipped to a stream..
entry = Chilkat::CkZipEntry.new()
success = zip.EntryMatching("*hamlet.xml",entry)
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

# There are three ways we can unzip (inflate) to a stream.
# 
# 1) Set a sink file on the stream object and call UnzipToStream synchronously.
#    This unzips to the stream's sink (which is to simply unzip to a file in the filesystem).
# 
# 2) Create a stream object and call UnzipToStreamAsync.  This starts the unzip in a background
#    thread (after Task.Run is called).  Your application can then read the unzipped (inflated) file
#    directly from the stream.
# 
# 3) (not shown in this example) Unzip to a stream object that is the source of something else.
#    

# ----------------------------------------------------------------
# Case 1: Unzip to a file by setting the sink of streamA to a file.
streamA = Chilkat::CkStream.new()
streamA.put_SinkFile("qa_output/hamletA.xml")

success = entry.UnzipToStream(streamA)
if (success != true)
    print entry.lastErrorText() + "\n";
    exit
end

# Close the stream to close the output file.
success = streamA.WriteClose()

# ----------------------------------------------------------------
# Case 2a: Uzip to a stream asynchronously. 
streamB = Chilkat::CkStream.new()

# unzipTask is a CkTask
unzipTask = entry.UnzipToStreamAsync(streamB)
if (entry.get_LastMethodSuccess() != true)
    print entry.lastErrorText() + "\n";
    exit
end

# Start the background unzip thread.
unzipTask.Run()

# Read the stream.  (this is reading the unzipped file data)
sb = Chilkat::CkStringBuilder.new()
while streamB.get_EndOfStream() != true
    # Each call to ReadSb appends to the contents of sb.
    streamB.ReadSb(sb)
end
sb.WriteFile("qa_output/hamletB.xml","utf-8",false)

print "Success." + "\n";

# ----------------------------------------------------------------
# Case 2b: Uzip to a stream asynchronously and emit output while reading. 
streamC = Chilkat::CkStream.new()

# unzipTask is a CkTask
unzipTask = entry.UnzipToStreamAsync(streamC)
if (entry.get_LastMethodSuccess() != true)
    print entry.lastErrorText() + "\n";
    exit
end

unzipTask.Run()

while streamC.get_EndOfStream() != true
    s = streamC.readString()
    print s + "\n";
end

print "Success." + "\n";