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/Extra/Base.html | 401 ++++++++++++++++++++++++++++++++++++++++++++++ Zip/Extra/Zip64.html | 437 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 838 insertions(+) create mode 100644 Zip/Extra/Base.html create mode 100644 Zip/Extra/Zip64.html (limited to 'Zip/Extra') diff --git a/Zip/Extra/Base.html b/Zip/Extra/Base.html new file mode 100644 index 0000000..fc9fcc9 --- /dev/null +++ b/Zip/Extra/Base.html @@ -0,0 +1,401 @@ + + + + + + + + Zip::Extra::Base - github.com/pablotron/zip-crystal + + + +
+ + + + + + +
+ +
+

+ + class Zip::Extra::Base + +

+ + + + + + + +

Overview

+ +

Raw 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
+ + + + + + + + + +

Direct Known Subclasses

+ + + + + + + +

Defined in:

+ + + + + + +

Class Method Summary

+ + + + +

Instance Method Summary

+ + + + + + +
+ + + + + + + + + + + + + + + +
+ + +

Class Method Detail

+ +
+
+ + def self.new(code : UInt16, data : Bytes) + + # +
+ +

Create a new raw extra data entry.

+ +

You should not need to instantiate this class directly; it is +created as-needed by Writer#add.

+ +
+
+ +
+
+ + + + +

Instance Method Detail

+ +
+
+ + def bytes_needed : UInt16 + + # +
+ +

Return number of bytes needed for this Extra.

+ +
+
+ +
+
+ +
+
+ + def code : UInt16 + + # +
+ +

Identifier for this extra entry.

+ +
+
+ +
+
+ +
+
+ + def code=(code) + + # +
+ +

Identifier for this extra entry.

+ +
+
+ +
+
+ +
+
+ + def data : Slice(UInt8) + + # +
+ +

Data for this extra entry.

+ +
+
+ +
+
+ +
+
+ + def data=(data) + + # +
+ +

Data for this extra entry.

+ +
+
+ +
+
+ +
+
+ + def to_s(io) : UInt16 + + # +
+ +
+
+ +
+
+ + + + + +
+ + + diff --git a/Zip/Extra/Zip64.html b/Zip/Extra/Zip64.html new file mode 100644 index 0000000..b5345a6 --- /dev/null +++ b/Zip/Extra/Zip64.html @@ -0,0 +1,437 @@ + + + + + + + + Zip::Extra::Zip64 - github.com/pablotron/zip-crystal + + + +
+ + + + + + +
+ +
+

+ + class Zip::Extra::Zip64 + +

+ + + + + + + +

Overview

+ +

ZIP64 extra data associated with Entry.

+ +

You should not need to instantiate this class directly; it is +created as-needed by Writer#add().

+ + + + + + + + + + + + + + +

Defined in:

+ + + + + +

Constant Summary

+ +
+ +
+ CODE = 1.to_u16 +
+ +
+

ZIP64 extra code

+
+ + +
+ + + +

Class Method Summary

+ + + + +

Instance Method Summary

+ + + + + + +
+ + + +

Instance methods inherited from class Zip::Extra::Base

+ + + + bytes_needed : UInt16 + bytes_needed, + + + + code : UInt16 + code, + + + + code=(code) + code=, + + + + data : Slice(UInt8) + data, + + + + data=(data) + data=, + + + + to_s(io) : UInt16 + to_s + + + + + + +

Class methods inherited from class Zip::Extra::Base

+ + + + new(code : UInt16, data : Bytes) + new + + + + + + + + + + + + + + + + + + + +
+ + +

Class Method Detail

+ +
+
+ + def self.new(size : UInt64 = 0_u64, compressed_size : UInt64 = 0_u64, pos : UInt64 | Nil = nil, disk_start : UInt32 | Nil = nil) + + # +
+ +

Create ZIP64 extra data associated with Entry from given +attributes.

+ +

You should not need to instantiate this class directly; it is +created as-needed by Writer#add().

+ +
+
+ +
+
+ +
+
+ + def self.new(data : Bytes) + + # +
+ +

Parse ZIP64 extra data from given buffer.

+ +

You should not need to instantiate this class directly; it is +created as-needed by Archive.

+ +
+
+ +
+
+ + + + +

Instance Method Detail

+ +
+
+ + def compressed_size : UInt64 + + # +
+ +

Compressed file size (64-bit unsigned integer).

+ +
+
+ +
+
+ +
+
+ + def disk_start : UInt32 | Nil + + # +
+ +

Starting disk (optional).

+ +
+
+ +
+
+ +
+
+ + def pos : UInt64 | Nil + + # +
+ +

Position in output (optional).

+ +
+
+ +
+
+ +
+
+ + def size : UInt64 + + # +
+ +

File size (64-bit unsigned integer).

+ +
+
+ +
+
+ + + + + +
+ + + -- cgit v1.2.3