Module: Zstandard::FFIBindings

Extended by:
FFI::Library
Defined in:
lib/zstandard/ffi_bindings.rb

Defined Under Namespace

Classes: ZSTD_frameHeader, ZSTD_frameParams, ZSTD_parameters

Simple API collapse

Buffer-less streaming decompression collapse

Helpers collapse

Class Method Details

.zstd_compress(dst, dstCapacity, src, srcSize, compressionLevel) ⇒ size_t

Returns the compressed size.

Parameters:

  • dst (void*)
  • dstCapacity (size_t)
  • src (const void*)
  • srcSize (size_t)
  • compressionLevel (int)

Returns:

  • (size_t) —

    the compressed size



35
 
# File 'lib/zstandard/ffi_bindings.rb', line 35

attach_function :zstd_compress, :ZSTD_compress, [:pointer, :size_t, :pointer, :size_t, :int], :size_t

.zstd_compress_bound(srcSize) ⇒ size_t

Parameters:

  • srcSize (size_t)

Returns:

  • (size_t) 


41
 
# File 'lib/zstandard/ffi_bindings.rb', line 41

attach_function :zstd_compress_bound, :ZSTD_compressBound, [:size_t], :size_t

.zstd_create_dctx ⇒ ZSTD_DCtx*

Returns:

  • (ZSTD_DCtx*) 


57
 
# File 'lib/zstandard/ffi_bindings.rb', line 57

attach_function :zstd_create_dctx, :ZSTD_createDCtx, [], :pointer

.zstd_decompress(dst, dstCapacity, src, compressedSize) ⇒ size_t

Returns the decompressed size.

Parameters:

  • dst (void*)
  • dstCapacity (size_t)
  • src (const void*)
  • compressedSize (size_t)

Returns:

  • (size_t) —

    the decompressed size



49
 
# File 'lib/zstandard/ffi_bindings.rb', line 49

attach_function :zstd_decompress, :ZSTD_decompress, [:pointer, :size_t, :pointer, :size_t], :size_t

.zstd_decompress_begin(dctx) ⇒ size_t

Parameters:

  • dctx (ZSTD_DCtx*)

Returns:

  • (size_t) 


62
 
# File 'lib/zstandard/ffi_bindings.rb', line 62

attach_function :zstd_decompress_begin, :ZSTD_decompressBegin, [:pointer], :size_t

.zstd_decompress_continue(dctx, dst, dstCapacity, src, srcSize) ⇒ size_t

Parameters:

  • dctx (ZSTD_DCtx*)
  • dst (void*)
  • dstCapacity (size_t)
  • src (const void*)
  • srcSize (size_t)

Returns:

  • (size_t) 


71
 
# File 'lib/zstandard/ffi_bindings.rb', line 71

attach_function :zstd_decompress_continue, :ZSTD_decompressContinue, [:pointer, :pointer, :size_t, :pointer, :size_t], :size_t

.zstd_free_dctx(dctx) ⇒ size_t

Parameters:

  • dctx (ZSTD_DCtx*)

Returns:

  • (size_t) 


84
 
# File 'lib/zstandard/ffi_bindings.rb', line 84

attach_function :zstd_free_dctx, :ZSTD_freeDCtx, [:pointer], :size_t

Instance Method Details

#zstd_get_error_name(code) ⇒ const char*

Parameters:

  • code (size_t)

Returns:

  • (const char*) 


110
 
# File 'lib/zstandard/ffi_bindings.rb', line 110

attach_function :zstd_get_error_name, :ZSTD_getErrorName, [:size_t], :pointer

#zstd_is_error(code) ⇒ unsigned

Returns an integer indicating if this is an error code. A value > 0 indicates true.

Parameters:

  • code (size_t)

Returns:

  • (unsigned) —

    an integer indicating if this is an error code. A value > 0 indicates true.



116
 
# File 'lib/zstandard/ffi_bindings.rb', line 116

attach_function :zstd_is_error, :ZSTD_isError, [:size_t], :uint

#zstd_next_src_size_to_deompress(dctx) ⇒ size_t

Parameters:

  • dctx (ZSTD_DCtx*)

Returns:

  • (size_t) 


101
 
# File 'lib/zstandard/ffi_bindings.rb', line 101

attach_function :zstd_next_src_size_to_deompress, :ZSTD_nextSrcSizeToDecompress, [:pointer], :size_t

#zstd_version_number ⇒ uint

Returns:

  • (uint) 



# File 'lib/zstandard/ffi_bindings.rb', line 118