Class: VibeZstd::CDict

Inherits:

Object

• Object
• VibeZstd::CDict

Defined in:

lib/vibe_zstd.rb,
sig/vibe_zstd.rbs,
ext/vibe_zstd/vibe_zstd.c

Overview

Pre-digested compression dictionary

Class Method Summary

• .estimate_memory(dict_size, level) ⇒ Object

  CDict.estimate_memory(dict_size, level).

Instance Method Summary

• #dict_id ⇒ Object

  CDict dict_id method - returns dictionary ID.

• #initialize ⇒ CDict constructor

  A new instance of CDict.

• #size ⇒ Object

  CDict size method - returns the size in memory.

• #to_ddict ⇒ DDict (also: #ddict)

  Get or create a matching DDict from this CDict's dictionary data The DDict is cached so it's only created once.

Constructor Details

#initialize ⇒ CDict

Returns a new instance of CDict.

Parameters:

• dict_data (String)
• level (Integer, nil)

# File 'sig/vibe_zstd.rbs', line 29

def initialize: (String dict_data, ?Integer? level) -> void

Class Method Details

.estimate_memory(dict_size, level) ⇒ Object

CDict.estimate_memory(dict_size, level)

# File 'ext/vibe_zstd/dict.c', line 607

def self.estimate_memory: (Integer dict_size, Integer level) -> Integer

Instance Method Details

#dict_id ⇒ Object

CDict dict_id method - returns dictionary ID

# File 'ext/vibe_zstd/dict.c', line 59

def dict_id: () -> Integer

#size ⇒ Object

CDict size method - returns the size in memory

# File 'ext/vibe_zstd/dict.c', line 47

def size: () -> Integer

#to_ddict ⇒ DDict Also known as: ddict

Get or create a matching DDict from this CDict's dictionary data The DDict is cached so it's only created once

Returns:

• (DDict) —

  Decompression dictionary matching this compression dictionary

# File 'lib/vibe_zstd.rb', line 81

def to_ddict
  @ddict ||= DDict.new(@dict_data)
end