Extractor

---

Object Hierarchy:

Description:

Content:

Properties:

• public uint completed_files { get; }
• public uint64 completed_size { get; }
• public bool delete_after_extraction { get; set construct; }
• public int64 notify_interval { get; set construct; }
• public File output_file { get; construct; }
• public bool output_is_dest { get; set construct; }
• public File source_file { get; construct; }
• public uint total_files { get; }
• public uint64 total_size { get; }

Static methods:

• public static Quark quark ()
  Gets the Extractor Error Quark.

Creation methods:

• public Extractor (File source_file, File output_file)
  Create a new Extractor object.

Methods:

• public uint get_completed_files ()
  Gets the number of files has been written to disk.
• public uint64 get_completed_size ()
  Gets the size in bytes has been written to disk.
• public bool get_delete_after_extraction ()
  Whether the source archive will be deleted after a successful extraction.
• public int64 get_notify_interval ()
  See set_notify_interval.
• public unowned File get_output_file ()
  Gets the File object which represents the output directory of extracted file or directory, or the extracted file or directory itself if you set output_is_dest on the returned object.
• public bool get_output_is_dest ()
  See set_output_is_dest.
• public unowned File get_source_file ()
  Gets the File object which represents the source archive that will be extracted for this object.
• public uint get_total_files ()
  Gets the total number of files will be written when the operation is completed.
• public uint64 get_total_size ()
  Gets the size in bytes will be written when the operation is completed.
• public void set_delete_after_extraction (bool delete_after_extraction)
  By default delete_after_extraction is set to false so the source archive will not be automatically deleted if extraction succeeds.
• public void set_notify_interval (int64 notify_interval)
  Sets the minimal interval between emission of progress signal.
• public void set_output_is_dest (bool output_is_dest)
  By default output_is_dest is set to false, which means only one file or directory will be created in output_file .
• public void set_passphrase (string passphrase)
  Sets a passphrase to use if the file to decompress is passphrase-protected.
• public void start (Cancellable? cancellable = null)
  Runs the archive extracting work.
• public void start_async (Cancellable? cancellable = null)
  Asynchronously runs the archive extracting work.

Signals:

• public signal void cancelled ()
  This signal is emitted after archive extracting job is cancelled by the Cancellable.
• public signal void completed ()
  This signal is emitted after the archive extracting job is successfully completed.
• public signal uint conflict (File file, void* new_file)
• public signal Object decide_destination (File destination, void* files)
• public signal void error (Error error)
  This signal is emitted when error occurs and all jobs should be terminated.
• public signal void progress (uint64 completed_size, uint completed_files)
  This signal is used to report progress of extraction.
• public signal string request_passphrase ()
  This signal is emitted when the archive extracting job needs a passphrase.
• public signal void scanned (uint files)
  This signal is emitted when Extractor finish scanning filename entries in the source archive.

Inherited Members: