vibe_zstd 1.0.0

data/sig/vibe_zstd.rbs

@@ -0,0 +1,76 @@
+module VibeZstd
+  VERSION: String
+
+  # Compression context for reusable compression operations
+  class CCtx
+    def initialize: () -> void
+    def compress: (String data, ?Integer? level, ?CDict? dict, ?pledged_size: Integer?) -> String
+    def set_parameter: (Symbol param, Integer value) -> self
+    def get_parameter: (Symbol param) -> Integer
+    def use_prefix: (String prefix_data) -> self
+    def self.parameter_bounds: (Symbol param) -> Hash[Symbol, Integer]
+    def self.estimate_memory: (Integer level) -> Integer
+  end
+
+  # Decompression context for reusable decompression operations
+  class DCtx
+    def initialize: () -> void
+    def decompress: (String data, ?DDict? dict) -> String
+    def set_parameter: (Symbol param, Integer value) -> self
+    def get_parameter: (Symbol param) -> Integer
+    def use_prefix: (String prefix_data) -> self
+    def self.parameter_bounds: (Symbol param) -> Hash[Symbol, Integer]
+    def self.frame_content_size: (String data) -> Integer?
+    def self.estimate_memory: () -> Integer
+  end
+
+  # Pre-digested compression dictionary
+  class CDict
+    def initialize: (String dict_data, ?Integer? level) -> void
+    def size: () -> Integer
+    def dict_id: () -> Integer
+    def self.estimate_memory: (Integer dict_size, Integer level) -> Integer
+  end
+
+  # Pre-digested decompression dictionary
+  class DDict
+    def initialize: (String dict_data) -> void
+    def size: () -> Integer
+    def dict_id: () -> Integer
+    def self.estimate_memory: (Integer dict_size) -> Integer
+  end
+
+  module Compress
+    # Streaming compression writer
+    class Writer
+      def initialize: (IO io, ?level: Integer?, ?dict: CDict?, ?pledged_size: Integer?) -> void
+      def write: (String data) -> self
+      def flush: () -> self
+      def finish: () -> self
+      def close: () -> self
+    end
+  end
+
+  module Decompress
+    # Streaming decompression reader
+    class Reader
+      def initialize: (IO io, ?dict: DDict?) -> void
+      def read: (?Integer? size) -> String?
+    end
+  end
+
+  # Module-level convenience methods
+  def self.compress: (String data, ?level: Integer?, ?dict: CDict?) -> String
+  def self.decompress: (String data, ?dict: DDict?) -> String
+  def self.frame_content_size: (String data) -> Integer?
+
+  # Dictionary training and utilities
+  def self.train_dict: (Array[String] samples, ?max_dict_size: Integer?) -> String
+  def self.train_dict_cover: (Array[String] samples, ?max_dict_size: Integer?, ?k: Integer?, ?d: Integer?, ?steps: Integer?, ?split_point: Float?, ?shrink_dict: bool?, ?shrink_dict_max_regression: Integer?, ?nb_threads: Integer?) -> String
+  def self.train_dict_fast_cover: (Array[String] samples, ?max_dict_size: Integer?, ?k: Integer?, ?d: Integer?, ?f: Integer?, ?steps: Integer?, ?split_point: Float?, ?accel: Integer?, ?shrink_dict: bool?, ?shrink_dict_max_regression: Integer?, ?nb_threads: Integer?) -> String
+  def self.get_dict_id: (String dict_data) -> Integer
+  def self.get_dict_id_from_frame: (String data) -> Integer
+
+  # Compression utilities
+  def self.compress_bound: (Integer size) -> Integer
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: vibe_zstd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kelley Reynolds
+bindir: exe
+cert_chain: []
+date: 2025-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Fast, idiomatic Ruby bindings for Zstandard (zstd) compression library
+email:
+- kelley@water5000.com
+executables: []
+extensions:
+- ext/vibe_zstd/extconf.rb
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/README.md
+- benchmark/compression_levels.rb
+- benchmark/context_reuse.rb
+- benchmark/decompression_speed_by_level.rb
+- benchmark/dictionary_training.rb
+- benchmark/dictionary_usage.rb
+- benchmark/for_readme.rb
+- benchmark/generate_fixture.rb
+- benchmark/helpers.rb
+- benchmark/multithreading.rb
+- benchmark/run_all.rb
+- benchmark/streaming.rb
+- ext/vibe_zstd/Makefile
+- ext/vibe_zstd/cctx.c
+- ext/vibe_zstd/dctx.c
+- ext/vibe_zstd/dict.c
+- ext/vibe_zstd/extconf.rb
+- ext/vibe_zstd/frames.c
+- ext/vibe_zstd/libzstd/LICENSE
+- ext/vibe_zstd/libzstd/common/allocations.h
+- ext/vibe_zstd/libzstd/common/bits.h
+- ext/vibe_zstd/libzstd/common/bitstream.h
+- ext/vibe_zstd/libzstd/common/compiler.h
+- ext/vibe_zstd/libzstd/common/cpu.h
+- ext/vibe_zstd/libzstd/common/debug.c
+- ext/vibe_zstd/libzstd/common/debug.h
+- ext/vibe_zstd/libzstd/common/entropy_common.c
+- ext/vibe_zstd/libzstd/common/error_private.c
+- ext/vibe_zstd/libzstd/common/error_private.h
+- ext/vibe_zstd/libzstd/common/fse.h
+- ext/vibe_zstd/libzstd/common/fse_decompress.c
+- ext/vibe_zstd/libzstd/common/huf.h
+- ext/vibe_zstd/libzstd/common/mem.h
+- ext/vibe_zstd/libzstd/common/pool.c
+- ext/vibe_zstd/libzstd/common/pool.h
+- ext/vibe_zstd/libzstd/common/portability_macros.h
+- ext/vibe_zstd/libzstd/common/threading.c
+- ext/vibe_zstd/libzstd/common/threading.h
+- ext/vibe_zstd/libzstd/common/xxhash.c
+- ext/vibe_zstd/libzstd/common/xxhash.h
+- ext/vibe_zstd/libzstd/common/zstd_common.c
+- ext/vibe_zstd/libzstd/common/zstd_deps.h
+- ext/vibe_zstd/libzstd/common/zstd_internal.h
+- ext/vibe_zstd/libzstd/common/zstd_trace.h
+- ext/vibe_zstd/libzstd/compress/clevels.h
+- ext/vibe_zstd/libzstd/compress/fse_compress.c
+- ext/vibe_zstd/libzstd/compress/hist.c
+- ext/vibe_zstd/libzstd/compress/hist.h
+- ext/vibe_zstd/libzstd/compress/huf_compress.c
+- ext/vibe_zstd/libzstd/compress/zstd_compress.c
+- ext/vibe_zstd/libzstd/compress/zstd_compress_internal.h
+- ext/vibe_zstd/libzstd/compress/zstd_compress_literals.c
+- ext/vibe_zstd/libzstd/compress/zstd_compress_literals.h
+- ext/vibe_zstd/libzstd/compress/zstd_compress_sequences.c
+- ext/vibe_zstd/libzstd/compress/zstd_compress_sequences.h
+- ext/vibe_zstd/libzstd/compress/zstd_compress_superblock.c
+- ext/vibe_zstd/libzstd/compress/zstd_compress_superblock.h
+- ext/vibe_zstd/libzstd/compress/zstd_cwksp.h
+- ext/vibe_zstd/libzstd/compress/zstd_double_fast.c
+- ext/vibe_zstd/libzstd/compress/zstd_double_fast.h
+- ext/vibe_zstd/libzstd/compress/zstd_fast.c
+- ext/vibe_zstd/libzstd/compress/zstd_fast.h
+- ext/vibe_zstd/libzstd/compress/zstd_lazy.c
+- ext/vibe_zstd/libzstd/compress/zstd_lazy.h
+- ext/vibe_zstd/libzstd/compress/zstd_ldm.c
+- ext/vibe_zstd/libzstd/compress/zstd_ldm.h
+- ext/vibe_zstd/libzstd/compress/zstd_ldm_geartab.h
+- ext/vibe_zstd/libzstd/compress/zstd_opt.c
+- ext/vibe_zstd/libzstd/compress/zstd_opt.h
+- ext/vibe_zstd/libzstd/compress/zstd_preSplit.c
+- ext/vibe_zstd/libzstd/compress/zstd_preSplit.h
+- ext/vibe_zstd/libzstd/compress/zstdmt_compress.c
+- ext/vibe_zstd/libzstd/compress/zstdmt_compress.h
+- ext/vibe_zstd/libzstd/decompress/huf_decompress.c
+- ext/vibe_zstd/libzstd/decompress/huf_decompress_amd64.S
+- ext/vibe_zstd/libzstd/decompress/zstd_ddict.c
+- ext/vibe_zstd/libzstd/decompress/zstd_ddict.h
+- ext/vibe_zstd/libzstd/decompress/zstd_decompress.c
+- ext/vibe_zstd/libzstd/decompress/zstd_decompress_block.c
+- ext/vibe_zstd/libzstd/decompress/zstd_decompress_block.h
+- ext/vibe_zstd/libzstd/decompress/zstd_decompress_internal.h
+- ext/vibe_zstd/libzstd/deprecated/zbuff.h
+- ext/vibe_zstd/libzstd/deprecated/zbuff_common.c
+- ext/vibe_zstd/libzstd/deprecated/zbuff_compress.c
+- ext/vibe_zstd/libzstd/deprecated/zbuff_decompress.c
+- ext/vibe_zstd/libzstd/dictBuilder/cover.c
+- ext/vibe_zstd/libzstd/dictBuilder/cover.h
+- ext/vibe_zstd/libzstd/dictBuilder/divsufsort.c
+- ext/vibe_zstd/libzstd/dictBuilder/divsufsort.h
+- ext/vibe_zstd/libzstd/dictBuilder/fastcover.c
+- ext/vibe_zstd/libzstd/dictBuilder/zdict.c
+- ext/vibe_zstd/libzstd/zdict.h
+- ext/vibe_zstd/libzstd/zstd.h
+- ext/vibe_zstd/libzstd/zstd_errors.h
+- ext/vibe_zstd/streaming.c
+- ext/vibe_zstd/vibe_zstd.c
+- ext/vibe_zstd/vibe_zstd.h
+- ext/vibe_zstd/vibe_zstd_internal.h
+- lib/vibe_zstd.rb
+- lib/vibe_zstd/constants.rb
+- lib/vibe_zstd/version.rb
+- sig/vibe_zstd.rbs
+homepage: https://github.com/kreynolds/vibe_zstd
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kreynolds/vibe_zstd
+  source_code_uri: https://github.com/kreynolds/vibe_zstd
+  changelog_uri: https://github.com/kreynolds/vibe_zstd/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Ruby bindings for Zstandard compression
+test_files: []