Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

GZip

Operations and tasks for working with gzip compressed files.

Nested types and modules

TypeDescription
GZipCompressionParams
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

The gzip archive compression parameters.

Functions and values

Function or valueDescription
CompressFile setParams outFile file
Signature: setParams:(GZipCompressionParams -> GZipCompressionParams) -> outFile:FileInfo -> file:FileInfo -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Compresses a file using gzip.

Parameters

  • setParams - A function which modifies the default compression parameters.
  • outFile - The compressed output file. If existing, will be overwritten.
  • file - The file to be compressed.
CompressFileWithDefaults outFile file
Signature: outFile:FileInfo -> file:FileInfo -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Compresses a file using gzip.

Parameters

  • outFile - The compressed output file. If existing, will be overwritten.
  • file - The file to be compressed.
compressStream arg1 inner
Signature: GZipCompressionParams -> inner:Stream -> GZipOutputStream
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Wraps an output stream with a gzip compressor.
createFile gzipParams file
Signature: gzipParams:GZipCompressionParams -> file:FileInfo -> GZipOutputStream
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Creates a GZipOutputStream wrapping a file using the given parameters.

Parameters

  • gzipParams - The gzip compression parameters.
  • file - The FileInfo describing the location to which the compressed file should be written. Will be overwritten if it exists.
ExtractFile outFile file
Signature: outFile:FileInfo -> file:FileInfo -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Extracts a file compressed with gzip.

Parameters

  • outFile - The extracted output file. If existing, will be overwritten.
  • file - The compressed file.
extractStream(inner)
Signature: inner:Stream -> GZipInputStream
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Wraps an input stream with a zip decompressor.
GZipCompressionDefaults
Signature: GZipCompressionParams
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

The default gzip archive compression parameters

Defaults

  • Level - CompressionLevel.Default