ArchiveWriteOptions class final
Options honored by archive writers, passed through Archive.create /
ArchiveWriteFormat.openWriter.
Constructors
- ArchiveWriteOptions({ArchiveCompression? compression, String? password, bool encryptHeader = false, bool allowUnsafePaths = false})
-
Creates options; the defaults are what applications normally want.
const
Properties
- allowUnsafePaths → bool
-
Skip the writer's path-safety check, writing each entry's
ArchiveEntrySpec.path verbatim, including absolute paths, drive
letters, and
..segments that escape the archive root.final - compression → ArchiveCompression?
-
Default compression method for entries whose ArchiveEntrySpec does
not specify one.
nullmeans "the format's own default" (stored for TAR, deflate for ZIP). A format that cannot honor the requested method throws UnsupportedCompressionException at write time.final - encryptHeader → bool
-
Also encrypt the archive's header, hiding entry names and metadata
(7z
-mhe). Requires password; opening the archive then needs the password up front, not just to read an entry.final - hashCode → int
-
The hash code for this object.
no setterinherited
- password → String?
-
Password to encrypt the archive with (Phase 4,
doc/encryption-scope.md).null(the default) writes plaintext.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited