W3cubDocs

/Crystal 0.31

class Zip::Writer

Overview

Writes (streams) zip entries to an IO.

Example

require "zip"

File.open("./file.zip", "w") do |file|
  Zip::Writer.open(file) do |zip|
    # Add a file with a String content
    zip.add "foo.txt", "contents of foo"

    # Add a file and write data to it through an IO
    zip.add("bar.txt") do |io|
      io << "contents of bar"
    end

    # Add a file by referencing a file in the filesystem
    # (the file is automatically closed after this call)
    zip.add("baz.txt", File.open("./some_file.txt"))
  end
end

Defined in:

zip/writer.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(io : IO, sync_close = false)Source

Creates a new writer to the given io.

def self.new(filename : String)Source

Creates a new writer to the given filename.

Class Method Detail

def self.open(io : IO, sync_close = false, &block)Source

Creates a new writer to the given io, yields it to the given block, and closes it at the end.

def self.open(filename : String, &block)Source

Creates a new writer to the given filename, yields it to the given block, and closes it at the end.

Instance Method Detail

def add(filename : String, &block)Source

Adds an entry that will have the given filename and current time (Time.utc) and yields an IO to write that entry's contents.

def add(entry : Entry, &block)Source

Adds an entry and yields IO to write that entry's contents.

You can choose the Entry's compression method before adding it.

  • If the STORED compression method is used, its crc32, compressed size and uncompressed size must be set and be correct with respect to the data that will be written to the yielded IO.
  • If the DEFLATED compression method is used, crc32, compressed size and uncompressed size will be computed from the data written to the yielded IO.

You can also set the Entry's time (which is Time.utc by default) and extra data before adding it to the zip stream.

def add(filename_or_entry : String | Entry, string : String)Source

Adds an entry that will have string as its contents.

def add(filename_or_entry : String | Entry, bytes : Bytes)Source

Adds an entry that will have bytes as its contents.

def add(filename_or_entry : String | Entry, data : IO)Source

Adds an entry that will have its data copied from the given data. If the given data is a ::File, it is automatically closed after data is copied from it.

def add_dir(name)Source

Adds a directory entry that will have the given name.

def closeSource

Closes this zip writer.

def closed? : BoolSource

Returns true if this writer is closed.

def comment=(comment)Source

Sets the zip file comment

def sync_close=(sync_close)Source

Whether to close the enclosed IO when closing this writer.

def sync_close? : BoolSource

Whether to close the enclosed IO when closing this writer.

© 2012–2019 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.31.1/Zip/Writer.html