From a63cfd89ab6070e8c75b29535a615679552da764 Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Sat, 13 Aug 2016 14:31:15 -0400 Subject: update documentation --- Zip.html | 63 +++++- Zip/Archive.html | 17 +- Zip/CompressionMethod.html | 17 +- Zip/DeflateCompressionHelper.html | 17 +- Zip/Entry.html | 87 ++++---- Zip/Error.html | 17 +- Zip/Extra.html | 207 +++--------------- Zip/Extra/Base.html | 401 ++++++++++++++++++++++++++++++++++ Zip/Extra/Zip64.html | 437 ++++++++++++++++++++++++++++++++++++++ Zip/GeneralFlags.html | 17 +- Zip/NoneCompressionHelper.html | 17 +- Zip/Source.html | 17 +- Zip/TimeHelper.html | 17 +- Zip/Version.html | 26 ++- Zip/Writer.html | 69 +++--- Zip/Writers.html | 21 +- Zip/Writers/DirEntry.html | 48 +++-- Zip/Writers/FileEntry.html | 50 +++-- Zip/Writers/WriterEntry.html | 72 +++++-- index.html | 33 ++- 20 files changed, 1342 insertions(+), 308 deletions(-) create mode 100644 Zip/Extra/Base.html create mode 100644 Zip/Extra/Zip64.html diff --git a/Zip.html b/Zip.html index ca16367..577be1a 100644 --- a/Zip.html +++ b/Zip.html @@ -50,9 +50,24 @@ -
  • +
  • Extra + + +
  • @@ -134,11 +149,25 @@

    Library for reading and writing zip files.

    +

    Features:

    + + + +

    non-seekable IO)

    + + + +

    TODO:

    + + +

    Examples:

    Reading from a zip file:

    -
    # create output MemoryIO
    +
    require "zip-crystal/zip"
    +
    +# create output MemoryIO
     mem_io = MemoryIO.new
     
     # read from "foo.zip"
    @@ -187,8 +216,20 @@ mem_io = MemoryIO.
           
           
         
    +      
    + EMPTY_SLICE = Bytes.new(0) +
    + +
    +

    :nodoc: +Static, zero-length Bytes used when empty buffer reference is +needed. +:nodoc:

    +
    + +
    - MAGIC = {cdr_header: 33639248_u32, cdr_footer: 101010256_u32, file_header: 67324752_u32, file_footer: 134695760_u32} + MAGIC = {cdr_header: 33639248_u32, cdr_footer: 101010256_u32, file_header: 67324752_u32, file_footer: 134695760_u32, z64_footer: 101075792_u32, z64_locator: 117853008_u32}
    @@ -234,14 +275,14 @@ mem_io = MemoryIO.
  • - .write(io : IO, pos : UInt32 = 0_u32, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt32 + .write(io : IO, pos : UInt64 = 0_u64, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt64

    Create a Zip::Writer for the output IO io and yield it to the given block.

  • - .write(path : String, pos : UInt32 = 0_u32, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt32 + .write(path : String, pos : UInt64 = 0_u64, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt64

    Create a Zip::Writer for the output file path and yield it to the given block.

    @@ -342,12 +383,12 @@ io = MemoryIO.new< -
    +
    - def self.write(io : IO, pos : UInt32 = 0_u32, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt32 + def self.write(io : IO, pos : UInt64 = 0_u64, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt64 - # + #

    Create a Zip::Writer for the output IO io and yield it to @@ -369,12 +410,12 @@ the given block. Returns number of bytes written.

    -
    +
    - def self.write(path : String, pos : UInt32 = 0_u32, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt32 + def self.write(path : String, pos : UInt64 = 0_u64, comment : String = "", version : Version = Version::DEFAULT, &cb : Writer -> ) : UInt64 - # + #

    Create a Zip::Writer for the output file path and yield it to diff --git a/Zip/Archive.html b/Zip/Archive.html index cb75fac..c506a33 100644 --- a/Zip/Archive.html +++ b/Zip/Archive.html @@ -50,9 +50,24 @@

  • -
  • +
  • Extra + + +
  • diff --git a/Zip/CompressionMethod.html b/Zip/CompressionMethod.html index 83b022f..9f4cd7b 100644 --- a/Zip/CompressionMethod.html +++ b/Zip/CompressionMethod.html @@ -50,9 +50,24 @@
  • -
  • +
  • Extra + + +
  • diff --git a/Zip/DeflateCompressionHelper.html b/Zip/DeflateCompressionHelper.html index 6daf337..90d7051 100644 --- a/Zip/DeflateCompressionHelper.html +++ b/Zip/DeflateCompressionHelper.html @@ -50,9 +50,24 @@
  • -
  • +
  • Extra + + +
  • diff --git a/Zip/Entry.html b/Zip/Entry.html index 02dd78d..288ead0 100644 --- a/Zip/Entry.html +++ b/Zip/Entry.html @@ -50,9 +50,24 @@
  • -
  • +
  • Extra + + +
  • @@ -209,9 +224,9 @@ io = MemoryIO.new<
  • - #compressed_size : UInt32 + #compressed_size : UInt64 -

    Get compressed size for this Entry as a UInt32.

    +

    Get compressed size for this Entry.

  • @@ -237,7 +252,7 @@ io = MemoryIO.new<
  • - #extras : Array(Zip::Extra) + #extras : Array(Zip::Extra::Base)

    Get Extra data for this Entry as an Array.

    @@ -258,7 +273,7 @@ io = MemoryIO.new<
  • - #local_extras : Array(Extra) + #local_extras : Array(Extra::Base)

    Returns an array of Extra attributes for this Entry.

    @@ -279,16 +294,16 @@ io = MemoryIO.new<
  • - #pos : UInt32 + #pos : UInt64 -

    Get position for this Entry as a UInt32.

    +

    Get position for this Entry.

  • - #size : UInt32 + #size : UInt64 -

    Get uncompressed size for this Entry as a UInt32.

    +

    Get uncompressed size for this Entry.

  • @@ -314,14 +329,14 @@ io = MemoryIO.new<
  • - #write(path : String) : UInt32 + #write(path : String) : UInt64

    Write contents of Entry into given path path and return the number of bytes written.

  • - #write(dst_io : IO) : UInt32 + #write(dst_io : IO) : UInt64

    Write contents of Entry into given IO.

    @@ -422,15 +437,15 @@ io = MemoryIO.new< -
    +
    - def compressed_size : UInt32 + def compressed_size : UInt64 - # + #
    -

    Get compressed size for this Entry as a UInt32.

    +

    Get compressed size for this Entry.

    Zip.read("foo.zip") do |zip|
       # print compressed size for each entry
    @@ -514,12 +529,12 @@ io = MemoryIO.new<
           
    -
    +
    - def extras : Array(Zip::Extra) + def extras : Array(Zip::Extra::Base) - # + #

    Get Extra data for this Entry as an Array.

    @@ -583,12 +598,12 @@ io = MemoryIO.new<
    -
    +
    - def local_extras : Array(Extra) + def local_extras : Array(Extra::Base) - # + #

    Returns an array of Extra attributes for this Entry.

    @@ -597,7 +612,7 @@ io = MemoryIO.new< associated with the file entry itself, and the file's entry in the Central Directory.

    -

    The #extras method returns the Extra attributes from the +

    The #extras method returns the Extra attributes from the file's entry in the Central Directory, and this method returns the Extra data from the file entry itself.

    @@ -661,15 +676,15 @@ file's entry in the Central Directory, and this method returns the
    -
    +
    - def pos : UInt32 + def pos : UInt64 - # + #
    -

    Get position for this Entry as a UInt32.

    +

    Get position for this Entry.

    Zip.read("foo.zip") do |zip|
       # print position for each entry
    @@ -684,15 +699,15 @@ file's entry in the Central Directory, and this method returns the
           
    -
    +
    - def size : UInt32 + def size : UInt64 - # + #
    -

    Get uncompressed size for this Entry as a UInt32.

    +

    Get uncompressed size for this Entry.

    Zip.read("foo.zip") do |zip|
       # print uncompressed size for each entry
    @@ -776,12 +791,12 @@ file's entry in the Central Directory, and this method returns the
           
    -
    +
    - def write(path : String) : UInt32 + def write(path : String) : UInt64 - # + #

    Write contents of Entry into given path path and return the @@ -807,12 +822,12 @@ compression method is unsupported.

    -
    +
    - def write(dst_io : IO) : UInt32 + def write(dst_io : IO) : UInt64 - # + #

    Write contents of Entry into given IO.

    diff --git a/Zip/Error.html b/Zip/Error.html index 6aeba81..db4949e 100644 --- a/Zip/Error.html +++ b/Zip/Error.html @@ -50,9 +50,24 @@
  • -
  • +
  • Extra + + +
  • diff --git a/Zip/Extra.html b/Zip/Extra.html index 554e82b..cde4caa 100644 --- a/Zip/Extra.html +++ b/Zip/Extra.html @@ -50,9 +50,24 @@
  • -
  • +
  • Extra + + +
  • @@ -122,30 +137,17 @@

    - class Zip::Extra + module Zip::Extra

    - -

    Overview

    -

    Extra data associated with Entry.

    - -

    You should not need to instantiate this class directly; use -Zip::Entry#extras or Zip::Entry#local_extras instead.

    - -

    Example:

    - -
    # open "foo.zip"
    -Zip.read("foo.zip") do |zip|
    -  # get extra data associated with "bar.txt"
    -  extras = zip["bar.txt"].extras
    -end
    +

    Extra data handlers.

    @@ -171,54 +173,16 @@ - - - -

    Instance Method Summary

    -