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

ArchiveHelper

Provides utility tasks for storing and compressing files in archives.

Nested types and modules

TypeDescription
ArchiveFileSpec
OBSOLETE

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

A description of a file to be added to an archive.

ExtractEntrySpec
ModuleDescription
BZip2
OBSOLETE

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

Operations and tasks for working with gzip compressed files.

CompressionLevel
OBSOLETE

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

Provides validation of comression levels used for the zip and gzip compression algorithms.

GZip
OBSOLETE

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

Operations and tasks for working with gzip compressed files.

Tar
OBSOLETE

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

Operations and tasks for working with tar archives.

Zip
OBSOLETE

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

Operations and tasks for working with zip archives.

Functions and values

Function or valueDescription
addEntry(...)
Signature: prepareEntry:(FileInfo -> string -> '?12077) -> afterEntry:('?12078 -> '?12079) -> outStream:'?12078 -> ArchiveFileSpec -> '?12079
Type parameters: '?12077, '?12078, '?12079
allFilesInDirectory(baseDir)
Signature: baseDir:DirectoryInfo -> seq<FileInfo>
archiveFileSpec(file)
Signature: file:FileInfo -> ArchiveFileSpec
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

Constructs a file specification which will archive the file at the root.

archiveFileSpecWithBaseDir baseDir file
Signature: baseDir:DirectoryInfo -> file:FileInfo -> ArchiveFileSpec
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

Constructs a file specification which will archive the file with a path relative to the baseDir.

buildFileSpec flatten baseDir
Signature: flatten:bool -> baseDir:DirectoryInfo -> FileInfo -> ArchiveFileSpec
copyFileBuffered(...)
Signature: bufferSize:int -> outStream:'?12074 -> inStream:'?12075 -> unit
Type parameters: '?12074, '?12075
copyStreamBuffered(...)
Signature: bufferSize:int -> outStream:'?12071 -> inStream:'?12072 -> length:int64 -> unit
Type parameters: '?12071, '?12072
createArchive(...)
Signature: streamCreator:(FileInfo -> '?12087) -> addEntry:('?12087 -> '?12088 -> unit) -> archiveFile:FileInfo -> items:seq<'?12088> -> unit
Type parameters: '?12087, '?12088
createArchiveStream(...)
Signature: streamCreator:(Stream -> '?12083) -> archiveFile:FileInfo -> '?12083
Type parameters: '?12083
DefaultBufferSize
Signature: int
Attributes:
[<Literal>]
[<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

doCompression(...)
Signature: compressor:('?12094 -> seq<'?12095> -> '?12096) -> archivePath:'?12094 -> fileSpecGenerator:('?12097 -> '?12095) -> seq<'?12097> -> '?12096
Type parameters: '?12094, '?12095, '?12096, '?12097
extractEntries getNextEntry inStream
Signature: getNextEntry:('?12090 -> ExtractEntrySpec option) -> inStream:'?12090 -> unit
Type parameters: '?12090
extractEntry inStream entry
Signature: inStream:'?12081 -> entry:ExtractEntrySpec -> unit
Type parameters: '?12081
openArchiveStream(...)
Signature: streamCreator:(Stream -> '?12085) -> archiveFile:FileInfo -> '?12085
Type parameters: '?12085