Module: KoreFileFormat

Defined in:

lib/kore_fileformat.rb,
lib/kore_fileformat/native.rb,
lib/kore_fileformat/version.rb,
lib/kore_fileformat/compressor.rb,
lib/kore_fileformat/decompressor.rb

Defined Under Namespace

Modules: CompressionLevel, Native Classes: CompressionError, Compressor, Decompressor, Error

Constant Summary

VERSION =

"1.2.1"

Class Method Summary

• .compress(data) ⇒ String

  Compress data with default settings (Balanced).

• .compress_with_level(data, level = :balanced) ⇒ String

  Compress data with specific level.

• .decompress(data) ⇒ String

  Decompress data.

Class Method Details

.compress(data) ⇒ String

Compress data with default settings (Balanced)

Parameters:

• data (String, Bytes) —

  Data to compress

Returns:

• (String) —

  Compressed data

# File 'lib/kore_fileformat.rb', line 16

def self.compress(data)
  compress_with_level(data, :balanced)
end

.compress_with_level(data, level = :balanced) ⇒ String

Compress data with specific level

Parameters:

• data (String, Bytes) —

  Data to compress

• level (Symbol) (defaults to: :balanced) —

  Compression level (:fast, :balanced, :maximum)

Returns:

• (String) —

  Compressed data

# File 'lib/kore_fileformat.rb', line 24

def self.compress_with_level(data, level = :balanced)
  Compressor.new(level).compress(data)
end

.decompress(data) ⇒ String

Decompress data

Parameters:

• data (String, Bytes) —

  Compressed data

Returns:

• (String) —

  Decompressed data

# File 'lib/kore_fileformat.rb', line 31

def self.decompress(data)
  Decompressor.new.decompress(data)
end