class Zip::Writer

Overview

Writes (streams) zip entries to an IO.

Example

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

Instance methods inherited from class Reference

==(other : self)
==(other)
==
, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, class class, dup dup, hash hash, inspect(io : IO)
inspect
inspect
, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s
to_s(io : IO)
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io) : self from_yaml

Constructor Detail

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

Creates a new writer to the given io.


View source
def self.new(filename : String) #

Creates a new writer to the given filename.


View source

Class Method Detail

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

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


View source
def self.open(filename : String, &block) #

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


View source

Instance Method Detail

def add(filename : String, &block) #

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


View source
def add(entry : Entry, &block) #

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, compresed 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.now by default) and extra data before adding it to the zip stream.


View source
def add(filename_or_entry : String | Entry, string : String) #

Adds an entry that will have string as its contents.


View source
def add(filename_or_entry : String | Entry, bytes : Bytes) #

Adds an entry that will have bytes as its contents.


View source
def add(filename_or_entry : String | Entry, data : IO) #

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.


View source
def add_dir(name) #

Adds a directory entry that will have the given name.


View source
def close #

Closes this zip writer.


View source
def closed? : Bool #

Returns true if this writer is closed.


View source
def comment=(comment) #

Sets the zip file comment


View source
def sync_close=(sync_close) #

Whether to close the enclosed IO when closing this writer.


View source
def sync_close? : Bool #

Whether to close the enclosed IO when closing this writer.


View source