o

os

zip

object zip

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. zip
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class ZipRoot extends Path with AutoCloseable

    A filesystem root representing a zip file

  2. class ZipSource extends AnyRef

    A file or folder you want to include in a zip file.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(dest: Path, sources: Seq[ZipSource] = List(), excludePatterns: Seq[Regex] = List(), includePatterns: Seq[Regex] = List(), preserveMtimes: Boolean = false, deletePatterns: Seq[Regex] = List(), compressionLevel: Int = java.util.zip.Deflater.DEFAULT_COMPRESSION, followLinks: Boolean = true): Path

    Zips the provided list of files and directories into a single ZIP archive.

    Zips the provided list of files and directories into a single ZIP archive.

    Unix file permissions will be preserved when creating a new zip, i.e. when dest does not already exists.

    If dest already exists and is a zip, performs modifications to dest in place rather than creating a new zip. In that case, - Unix file permissions will be preserved if Java Runtime Version >= 14 - if using Java Runtime Version < 14, Unix file permissions are not preserved, even for existing zip entries - symbolics links will always be stored as the referenced files - existing symbolic links stored in the zip might lose their symbolic link file type field and become broken

    dest

    The path to the destination ZIP file.

    sources

    A list of paths to files and directories to be zipped. Defaults to an empty list.

    excludePatterns

    A list of regular expression patterns to exclude files from the ZIP archive. Defaults to an empty list.

    includePatterns

    A list of regular expression patterns to include files in the ZIP archive. Defaults to an empty list (includes all files).

    preserveMtimes

    Whether to preserve modification times (mtimes) of the files.

    deletePatterns

    A list of regular expression patterns to delete files from an existing ZIP archive before appending new ones.

    compressionLevel

    number from 0-9, where 0 is no compression and 9 is best compression. Defaults to -1 (default compression).

    followLinks

    Whether to store symbolic links as the referenced files. Default to true. Setting this to false has no effect when modifying a zip file in place.

    returns

    The path to the created ZIP archive.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def open(path: Path): ZipRoot

    Opens a zip file as a filesystem root that you can operate on using os.* APIs.

    Opens a zip file as a filesystem root that you can operate on using os.* APIs. Note that you need to call close() on the returned ZipRoot when you are done with it, to avoid leaking filesystem resources

  16. def stream(sources: Seq[ZipSource], excludePatterns: Seq[Regex] = List(), includePatterns: Seq[Regex] = List(), preserveMtimes: Boolean = false, compressionLevel: Int = java.util.zip.Deflater.DEFAULT_COMPRESSION, followLinks: Boolean = false): Writable

    Zips a folder recursively and returns a geny.Writable for streaming the ZIP data.

    Zips a folder recursively and returns a geny.Writable for streaming the ZIP data.

    excludePatterns

    A list of regular expression patterns to exclude files during zipping. Defaults to an empty list.

    includePatterns

    A list of regular expression patterns to include files in the ZIP archive. Defaults to an empty list (includes all files).

    preserveMtimes

    Whether to preserve modification times (mtimes) of the files.

    compressionLevel

    number from 0-9, where 0 is no compression and 9 is best compression. Defaults to -1 (default compression).

    followLinks

    Whether to store symbolic links as the referenced files. Default to true.

    returns

    A geny.Writable object for writing the ZIP data.

  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. object ZipSource

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped