EgretDoc
Back to Home
Location:system/compress.zlib

Module

Module documentation.

modulecompress.zlib

Classes

Classes and inheritance.

Functions

Free functions and class methods.

functioncompress.zlib::__zlib_deflate
Signatureextern func __zlib_deflate(input: String) -> String;
extern func __zlib_deflate(input: String) -> String;
/*
@brief Binds the low-level runtime symbol `__zlib_inflate`.
@briefBinds the low-level runtime symbol `__zlib_deflate`.
@detailsThis function is an external entry point used by system modules to access native runtime capabilities such as filesystem, networking, threading, GC, cryptography, or platform operations. Prefer the safe wrapper functions in the same file when available. When calling this entry directly, pass validated arguments that match the signature and handle failures according to the return-value convention.
@param
  • inputInput data supplied to the parser, encoder, digest, or transformation.
@returnReturns the operation result as `String`.
functioncompress.zlib::__zlib_inflate
Signatureextern func __zlib_inflate(input: String, max_output: Int) -> String;
extern func __zlib_inflate(input: String, max_output: Int) -> String;

/*
@briefBinds the low-level runtime symbol `__zlib_inflate`.
@detailsThis function is an external entry point used by system modules to access native runtime capabilities such as filesystem, networking, threading, GC, cryptography, or platform operations. Prefer the safe wrapper functions in the same file when available. When calling this entry directly, pass validated arguments that match the signature and handle failures according to the return-value convention.
@param
  • inputInput data supplied to the parser, encoder, digest, or transformation.
  • max_outputMaximum allowed count or byte size.
@returnReturns the operation result as `String`.
functioncompress.zlib::deflate
Signaturefunc deflate(input: String) -> String
func deflate(input: String) -> String {
    return __zlib_deflate(input);
}
@briefProvides the system library operation `deflate`.
@detailsExecutes the `deflate` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • inputInput data supplied to the parser, encoder, digest, or transformation.
@returnReturns the operation result as `String`.
functioncompress.zlib::inflate
Signaturefunc inflate(input: String, max_output: Int) -> String
func inflate(input: String, max_output: Int) -> String {
    return __zlib_inflate(input, max_output);
}
@briefProvides the system library operation `inflate`.
@detailsExecutes the `inflate` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • inputInput data supplied to the parser, encoder, digest, or transformation.
  • max_outputMaximum allowed count or byte size.
@returnReturns the operation result as `String`.

Variables

Class fields (var).