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.html | 207 +++++++++------------------------------------------------ 1 file changed, 31 insertions(+), 176 deletions(-) (limited to 'Zip/Extra.html') 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

    -
      -
    • - #code : UInt16 + .read(io) : Base -
      • - -
    • - #code=(code) - -
      • - -
    • - #data : Slice(UInt8) - -
      • - -
    • - #data=(data) - -
      • - -
    • - #size(*args, **options, &block) - -
      • - -
    • - #size(*args, **options) - -
      • - -
    • - #to_s(io) : UInt32 +

      Parse Extra data from given IO io.

      • @@ -228,67 +192,24 @@ -
      - - - - - - - - - - - - +

      Class Method Detail

      -
      -
      - - def self.new(code : UInt16, data : Bytes) - - # -
      - -
      -
      - -
      -
      - -
      +
      - def self.new(io) + def self.pack(extras : Array(Extra::Base) | Nil) : Bytes - # + #
      -
      -
      - -
      -
      - - - - -

      Instance Method Detail

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

      Encode array of Extra::Base and return buffer.


      @@ -296,27 +217,15 @@
      -
      +
      - def code=(code) + def self.read(io) : Base - # + #
      -
      -
      - -
      -
      - -
      -
      - - def data : Slice(UInt8) - - # -
      +

      Parse Extra data from given IO io.


      @@ -324,62 +233,8 @@
      -
      -
      - - def data=(data) - # -
      - -
      -
      - -
      -
      - -
      -
      - - def size(*args, **options, &block) - - # -
      - -
      -
      - -
      -
      - -
      -
      - - def size(*args, **options) - - # -
      - -
      -
      - -
      -
      - -
      -
      - - def to_s(io) : UInt32 - # -
      - -
      -
      - -
      -
      - -- cgit v1.2.3