From d64ce278f01cafc1c3c23aec9bb2394412ad160b Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Thu, 11 Aug 2016 00:30:34 -0400 Subject: update documentation --- Zip/Writers/DirEntry.html | 292 ++++++++++++++++++++++++++++++++++++ Zip/Writers/FileEntry.html | 315 +++++++++++++++++++++++++++++++++++++++ Zip/Writers/WriterEntry.html | 343 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 950 insertions(+) create mode 100644 Zip/Writers/DirEntry.html create mode 100644 Zip/Writers/FileEntry.html create mode 100644 Zip/Writers/WriterEntry.html (limited to 'Zip/Writers') diff --git a/Zip/Writers/DirEntry.html b/Zip/Writers/DirEntry.html new file mode 100644 index 0000000..a98b19c --- /dev/null +++ b/Zip/Writers/DirEntry.html @@ -0,0 +1,292 @@ + + + + + + + + Zip::Writers::DirEntry - github.com/pablotron/zip-crystal + + + +
+ + + + + + +
+ +
+

+ + class Zip::Writers::DirEntry + +

+ + + + + + + +

Overview

+ +

Internal class used to store files for Writer instance.

+ +

You should not need to instantiate this class directly; use +Writer#add_dir instead.

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

Defined in:

+ + + + + +

Constant Summary

+ +
+ +
+ FLAGS = GeneralFlags.flags(EFS) +
+ +
+

Default flags for local and central file header.

+
+ + +
+ + + +

Class Method Summary

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

Instance methods inherited from class Zip::Writers::WriterEntry

+ + + + to_s(dst_io) : UInt32 + to_s, + + + + write_body(dst_io : IO) + write_body, + + + + write_central(io : IO, version : Version = Version::DEFAULT) : UInt32 + write_central, + + + + write_footer(io : IO, crc : UInt32, src_len : UInt32, dst_len : UInt32) : UInt32 + write_footer + + + + + + +

Class methods inherited from class Zip::Writers::WriterEntry

+ + + + new(pos : UInt32, path : String, method : CompressionMethod = CompressionMethod::DEFLATE, time : Time = Time.now, comment : String = "", flags : GeneralFlags = GeneralFlags.flags, external : UInt32 = 0_u32) + new + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

Class Method Detail

+ +
+
+ + def self.new(pos : UInt32, path : String, time : Time = Time.now, comment : String = "") + + # +
+ +

Create a new DirEntry instance.

+ +

You should not need to call this method directly; use +Writer#add_dir instead.

+ +
+
+ +
+
+ + + + + + + +
+ + + diff --git a/Zip/Writers/FileEntry.html b/Zip/Writers/FileEntry.html new file mode 100644 index 0000000..b703720 --- /dev/null +++ b/Zip/Writers/FileEntry.html @@ -0,0 +1,315 @@ + + + + + + + + Zip::Writers::FileEntry - github.com/pablotron/zip-crystal + + + +
+ + + + + + +
+ +
+

+ + class Zip::Writers::FileEntry + +

+ + + + + + + +

Overview

+ +

Internal class used to store files for Writer instance.

+ +

You should not need to call this method directly; it is called +automatically by Writer#add and Writer#add_file.

+ + + + + +

Included Modules

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

Defined in:

+ + + + + +

Constant Summary

+ +
+ +
+ FLAGS = GeneralFlags.flags(FOOTER, EFS) +
+ +
+

Flags for local and central file header.

+
+ + +
+ + + +

Class Method Summary

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

Instance methods inherited from class Zip::Writers::WriterEntry

+ + + + to_s(dst_io) : UInt32 + to_s, + + + + write_body(dst_io : IO) + write_body, + + + + write_central(io : IO, version : Version = Version::DEFAULT) : UInt32 + write_central, + + + + write_footer(io : IO, crc : UInt32, src_len : UInt32, dst_len : UInt32) : UInt32 + write_footer + + + + + + +

Class methods inherited from class Zip::Writers::WriterEntry

+ + + + new(pos : UInt32, path : String, method : CompressionMethod = CompressionMethod::DEFLATE, time : Time = Time.now, comment : String = "", flags : GeneralFlags = GeneralFlags.flags, external : UInt32 = 0_u32) + new + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +

Class Method Detail

+ +
+
+ + def self.new(pos : UInt32, path : String, io : IO, method : CompressionMethod = CompressionMethod::DEFLATE, time : Time = Time.now, comment : String = "") + + # +
+ +

Create a new FileWriterEntry instance.

+ +

You should not need to call this method directly; it is called +automatically by Writer#add and Writer#add_file.

+ +
+
+ +
+
+ + + + + + + +
+ + + diff --git a/Zip/Writers/WriterEntry.html b/Zip/Writers/WriterEntry.html new file mode 100644 index 0000000..9442e7a --- /dev/null +++ b/Zip/Writers/WriterEntry.html @@ -0,0 +1,343 @@ + + + + + + + + Zip::Writers::WriterEntry - github.com/pablotron/zip-crystal + + + +
+ + + + + + +
+ +
+

+ + abstract class Zip::Writers::WriterEntry + +

+ + + + + + + +

Overview

+ +

Abstract base class for classes used to store files and directories +for Writer instance.

+ + + + + +

Included Modules

+ + + + + + +

Direct Known Subclasses

+ + + + + + + +

Defined in:

+ + + + + + +

Class Method Summary

+ + + + +

Instance Method Summary

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

Class Method Detail

+ +
+
+ + def self.new(pos : UInt32, path : String, method : CompressionMethod = CompressionMethod::DEFLATE, time : Time = Time.now, comment : String = "", flags : GeneralFlags = GeneralFlags.flags, external : UInt32 = 0_u32) + + # +
+ +
+
+ +
+
+ + + + +

Instance Method Detail

+ +
+
+ + def to_s(dst_io) : UInt32 + + # +
+ +

Write local file entry to IO and return the number of bytes +written.

+ +

You should not need to call this method directly; it is called +automatically by Writer#add and Writer#add_file.

+ +
+
+ +
+
+ +
+
+ abstract + def write_body(dst_io : IO) + + # +
+ +
+
+ +
+
+ +
+
+ + def write_central(io : IO, version : Version = Version::DEFAULT) : UInt32 + + # +
+ +

Write central directory data for this WriterEntry and return the +number of bytes written.

+ +

You never need to call this method directly; it is called +automatically by Writer#close.

+ +
+
+ +
+
+ +
+
+ abstract + def write_footer(io : IO, crc : UInt32, src_len : UInt32, dst_len : UInt32) : UInt32 + + # +
+ +
+
+ +
+
+ + + + + +
+ + + -- cgit v1.2.3