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

BZip2

Operations and tasks for working with gzip compressed files.

Functions and values

Function or valueDescription
CompressFile 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 bzip2.

Parameters

  • outFile - The compressed output file. If existing, will be overwritten.
  • file - The file to be compressed.
compressStream(inner)
Signature: inner:Stream -> BZip2OutputStream
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 bzip2 compressor.
createFile(file)
Signature: file:FileInfo -> BZip2OutputStream
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 BZip2OutputStream wrapping a file.

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 bzip2.

Parameters

  • outFile - The extracted output file. If existing, will be overwritten.
  • file - The compressed file.
extractStream(inner)
Signature: inner:Stream -> BZip2InputStream
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 bzip2 decompressor.