e621stream 0.0.0

data/sorbet/rbi/gems/protocol-hpack@1.5.1.rbi

@@ -0,0 +1,418 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `protocol-hpack` gem.
+# Please instead update this file by running `bin/tapioca gem protocol-hpack`.
+
+
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+# Machine generated Huffman decoder state machine.
+# DO NOT EDIT THIS FILE.
+# Released under the MIT License.
+# Copyright, 2018-2024, by Samuel Williams.
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/version.rb:6
+module Protocol; end
+
+# Implementation of header compression for HTTP 2.0 (HPACK) format adapted
+# to efficiently represent HTTP headers in the context of HTTP 2.0.
+#
+# - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/version.rb:7
+module Protocol::HPACK; end
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:19
+Protocol::HPACK::CHANGE_TABLE_SIZE_TYPE = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/error.rb:11
+class Protocol::HPACK::CompressionError < ::Protocol::HPACK::Error; end
+
+# Responsible for encoding header key-value pairs using HPACK algorithm.
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:44
+class Protocol::HPACK::Compressor
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:45
+  def initialize(buffer, context = T.unsafe(nil), table_size_limit: T.unsafe(nil)); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:54
+  def buffer; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:55
+  def context; end
+
+  # Encodes provided list of HTTP headers.
+  #
+  # @param headers [Array] +[[name, value], ...]+
+  # @return [Buffer]
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:173
+  def encode(headers, table_size = T.unsafe(nil)); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:93
+  def huffman; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:56
+  def offset; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:52
+  def table_size_limit; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:58
+  def write_bytes(bytes); end
+
+  # Encodes header command with appropriate header representation.
+  #
+  # @param h [Hash] header command
+  # @param buffer [String]
+  # @return [Buffer]
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:144
+  def write_header(command); end
+
+  # Encodes provided value via integer representation.
+  # - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10#section-5.1
+  #
+  #  If I < 2^N - 1, encode I on N bits
+  #  Else
+  #      encode 2^N - 1 on N bits
+  #      I = I - (2^N - 1)
+  #      While I >= 128
+  #           Encode (I % 128 + 128) on 8 bits
+  #           I = I / 128
+  #      encode (I) on 8 bits
+  #
+  # @param value [Integer] value to encode
+  # @param bits [Integer] number of available bits
+  # @return [String] binary string
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:77
+  def write_integer(value, bits); end
+
+  # Encodes provided value via string literal representation.
+  # - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10#section-5.2
+  #
+  # * The string length, defined as the number of bytes needed to store
+  #   its UTF-8 representation, is represented as an integer with a seven
+  #   bits prefix. If the string length is strictly less than 127, it is
+  #   represented as one byte.
+  # * If the bit 7 of the first byte is 1, the string value is represented
+  #   as a list of Huffman encoded octets
+  #   (padded with bit 1's until next octet boundary).
+  # * If the bit 7 of the first byte is 0, the string value is
+  #   represented as a list of UTF-8 encoded octets.
+  #
+  #  :never   Do not use Huffman encoding
+  #  :always  Always use Huffman encoding
+  #  :shorter Use Huffman when the result is strictly shorter
+  #
+  # @param string [String]
+  # @return [String] binary string
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:117
+  def write_string(string, huffman = T.unsafe(nil)); end
+end
+
+# To decompress header blocks, a decoder only needs to maintain a
+# dynamic table as a decoding context.
+# No other state information is needed.
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:33
+class Protocol::HPACK::Context
+  # Initializes compression context with appropriate client/server defaults and maximum size of the dynamic table.
+  #
+  # @param table [Array] Table of header key-value pairs.
+  # @option huffman [Symbol] One of `:always`, `:never`, `:shorter`. Controls use of compression.
+  # @option index [Symbol] One of `:all`, `:static`, `:never`. Controls use of static/dynamic tables.
+  # @option table_size [Integer] The current maximum dynamic table size.
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:119
+  def initialize(table = T.unsafe(nil), huffman: T.unsafe(nil), index: T.unsafe(nil), table_size: T.unsafe(nil)); end
+
+  # Emits command for a header.
+  # Prefer static table over dynamic table.
+  # Prefer exact match over name-only match.
+  #
+  # +@index+ controls whether to use the dynamic table,
+  # static table, or both.
+  #  :never   Do not use dynamic table or static table reference at all.
+  #  :static  Use static table only.
+  #  :all     Use all of them.
+  #
+  # @param name [String]
+  # @param value [String]
+  # @return [Hash] command
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:254
+  def add_command(name, value); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:307
+  def change_table_size(size); end
+
+  # Returns current table size in octets
+  # @return [Integer]
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:316
+  def compute_current_table_size; end
+
+  # Header Block Processing
+  # - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10#section-4.1
+  #
+  # @param command [Hash] {type:, name:, value:, index:}
+  # @return [Array] +[name, value]+ header field that is added to the decoded header list
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:169
+  def decode(command); end
+
+  # Finds an entry in current dynamic table by index.
+  # Note that index is zero-based in this module.
+  #
+  # If the index is greater than the last index in the static table,
+  # an entry in the dynamic table is dereferenced.
+  #
+  # If the index is greater than the last header index, an error is raised.
+  #
+  # @param index [Integer] zero-based index in the dynamic table.
+  # @return [Array] +[key, value]+
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:153
+  def dereference(index); end
+
+  # Plan header compression according to +@index+
+  #  :never   Do not use dynamic table or static table reference at all.
+  #  :static  Use static table only.
+  #  :all     Use all of them.
+  #
+  # @param headers [Array] +[[name, value], ...]+
+  # @return [Array] array of commands
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:224
+  def encode(headers); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:138
+  def huffman; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:139
+  def index; end
+
+  # Current table of header key-value pairs.
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:136
+  def table; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:141
+  def table_size; end
+
+  # Alter dynamic table size.
+  #  When the size is reduced, some headers might be evicted.
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:302
+  def table_size=(size); end
+
+  private
+
+  # Add a name-value pair to the dynamic table. Older entries might have been evicted so that the new entry fits in the dynamic table. The command and the component strings will be frozen.
+  #
+  # @param command [Array] +[name, value]+
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:325
+  def add_to_table(command); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:335
+  def entry_size(e); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:128
+  def initialize_copy(other); end
+
+  # To keep the dynamic table size lower than or equal to @table_size,
+  # remove one or more entries at the end of the dynamic table.
+  #
+  # @param command [Hash]
+  # @return [Boolean] whether +command+ fits in the dynamic table.
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:344
+  def size_check(command); end
+end
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:100
+Protocol::HPACK::Context::STATIC_EXACT_LOOKUP = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:101
+Protocol::HPACK::Context::STATIC_NAME_LOOKUP = T.let(T.unsafe(nil), Hash)
+
+# Static header table.
+# https://tools.ietf.org/html/rfc7541#appendix-A
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:36
+Protocol::HPACK::Context::STATIC_TABLE = T.let(T.unsafe(nil), Array)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/error.rb:14
+class Protocol::HPACK::DecompressionError < ::Protocol::HPACK::Error; end
+
+# Responsible for decoding received headers and maintaining compression
+# context of the opposing peer. Decompressor must be initialized with
+# appropriate starting context based on local role: client or server.
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:16
+class Protocol::HPACK::Decompressor
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:20
+  def initialize(buffer, context = T.unsafe(nil), table_size_limit: T.unsafe(nil)); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:28
+  def buffer; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:29
+  def context; end
+
+  # Decodes and processes header commands within provided buffer.
+  #
+  # @param buffer [Buffer]
+  # @return [Array] +[[name, value], ...]+
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:192
+  def decode(list = T.unsafe(nil)); end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:34
+  def end?; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:30
+  def offset; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:46
+  def peek_byte; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:38
+  def read_byte; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:50
+  def read_bytes(length); end
+
+  # Decodes header command from provided buffer.
+  #
+  # @param buffer [Buffer]
+  # @return [Hash] command
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:102
+  def read_header; end
+
+  # Decodes integer value from provided buffer.
+  #
+  # @param bits [Integer] number of available bits
+  # @return [Integer]
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:62
+  def read_integer(bits); end
+
+  # Decodes string value from provided buffer.
+  #
+  # @return [String] UTF-8 encoded string
+  # @raise [CompressionError] when input is malformed
+  #
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:82
+  def read_string; end
+
+  # pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:32
+  def table_size_limit; end
+end
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/decompressor.rb:18
+Protocol::HPACK::Decompressor::MASK_SHIFT_4 = T.let(T.unsafe(nil), Integer)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/error.rb:8
+class Protocol::HPACK::Error < ::StandardError; end
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:22
+Protocol::HPACK::HEADER_REPRESENTATION = T.let(T.unsafe(nil), Hash)
+
+# Implementation of huffman encoding for HPACK.
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/huffman/machine.rb:11
+class Protocol::HPACK::Huffman
+  class << self
+    # Decodes provided Huffman coded string.
+    #
+    # @param buf [Buffer]
+    # @return [String] binary string
+    # @raise [CompressionError] when Huffman coded string is malformed
+    #
+    # pkg:gem/protocol-hpack#lib/protocol/hpack/huffman.rb:37
+    def decode(buffer); end
+
+    # Encodes provided value via huffman encoding.
+    # Length is not encoded in this method.
+    #
+    # @param str [String]
+    # @return [String] binary string
+    #
+    # pkg:gem/protocol-hpack#lib/protocol/hpack/huffman.rb:26
+    def encode(str); end
+  end
+end
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/huffman.rb:18
+Protocol::HPACK::Huffman::BITS_AT_ONCE = T.let(T.unsafe(nil), Integer)
+
+# Huffman table as specified in https://tools.ietf.org/html/rfc7541#appendix-B
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/huffman.rb:68
+Protocol::HPACK::Huffman::CODES = T.let(T.unsafe(nil), Array)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/huffman.rb:328
+Protocol::HPACK::Huffman::ENCODE_TABLE = T.let(T.unsafe(nil), Array)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/huffman.rb:19
+Protocol::HPACK::Huffman::EOS = T.let(T.unsafe(nil), Integer)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/huffman/machine.rb:14
+Protocol::HPACK::Huffman::MACHINE = T.let(T.unsafe(nil), Array)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/huffman/machine.rb:13
+Protocol::HPACK::Huffman::MAX_FINAL_STATE = T.let(T.unsafe(nil), Integer)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:20
+Protocol::HPACK::INCREMENTAL_TYPE = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:21
+Protocol::HPACK::INDEXED_TYPE = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:24
+Protocol::HPACK::LINEAR = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:28
+Protocol::HPACK::LINEAR_HUFFMAN = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:32
+Protocol::HPACK::MODES = T.let(T.unsafe(nil), Hash)
+
+# Predefined options set for Compressor
+# http://mew.org/~kazu/material/2014-hpack.pdf
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:23
+Protocol::HPACK::NAIVE = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:27
+Protocol::HPACK::NAIVE_HUFFMAN = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:18
+Protocol::HPACK::NEVER_INDEXED_TYPE = T.let(T.unsafe(nil), Hash)
+
+# Header representation as defined by the spec.
+#
+# pkg:gem/protocol-hpack#lib/protocol/hpack/context.rb:17
+Protocol::HPACK::NO_INDEX_TYPE = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:26
+Protocol::HPACK::SHORTER = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:30
+Protocol::HPACK::SHORTER_HUFFMAN = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:25
+Protocol::HPACK::STATIC = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/compressor.rb:29
+Protocol::HPACK::STATIC_HUFFMAN = T.let(T.unsafe(nil), Hash)
+
+# pkg:gem/protocol-hpack#lib/protocol/hpack/version.rb:8
+Protocol::HPACK::VERSION = T.let(T.unsafe(nil), String)