Struct webkit6::Download

pub struct Download { /* private fields */ }

Object used to communicate with the application when downloading.

#WebKitDownload carries information about a download request and response, including a #WebKitURIRequest and a #WebKitURIResponse objects. The application may use this object to control the download process, or to simply figure out what is to be downloaded, and handle the download process itself.

Properties

allow-overwrite

Whether or not the download is allowed to overwrite an existing file on disk. If this property is false and the destination already exists, the download will fail.

Readable | Writeable

destination

The local path to where the download will be saved.

Readable

estimated-progress

An estimate of the percent completion for the download operation. This value will range from 0.0 to 1.0. The value is an estimate based on the total number of bytes expected to be received for a download. If you need a more accurate progress information you can connect to #WebKitDownload::received-data signal to track the progress.

Readable

response

The #WebKitURIResponse associated with this download.

Readable

Signals

created-destination

This signal is emitted after #WebKitDownload::decide-destination and before #WebKitDownload::received-data to notify that destination file has been created successfully at @destination.

decide-destination

This signal is emitted after response is received to decide a destination for the download using webkit_download_set_destination(). If this signal is not handled, the file will be downloaded to G_USER_DIRECTORY_DOWNLOAD directory using @suggested_filename.

Since 2.40, you may handle this signal asynchronously by returning true without calling webkit_download_set_destination(). This indicates intent to eventually call webkit_download_set_destination(). In this case, the download will not proceed until the destination is set or cancelled with webkit_download_cancel().

failed

This signal is emitted when an error occurs during the download operation. The given @error, of the domain WEBKIT_DOWNLOAD_ERROR, contains further details of the failure. If the download is cancelled with webkit_download_cancel(), this signal is emitted with error DownloadError::CancelledByUser. The download operation finishes after an error and #WebKitDownload::finished signal is emitted after this one.

finished

This signal is emitted when download finishes successfully or due to an error. In case of errors #WebKitDownload::failed signal is emitted before this one.

received-data

This signal is emitted after response is received, every time new data has been written to the destination. It’s useful to know the progress of the download operation.

GLib type: GObject with reference counted clone semantics.

Implementations

impl Download

pub fn cancel(&self)

Cancels the download.

When the ongoing download operation is effectively cancelled the signal #WebKitDownload::failed is emitted with DownloadError::CancelledByUser error.

pub fn allows_overwrite(&self) -> bool

Returns the current value of the #WebKitDownload:allow-overwrite property.

Returns the current value of the #WebKitDownload:allow-overwrite property, which determines whether the download will overwrite an existing file on disk, or if it will fail if the destination already exists.

Returns

the current value of the #WebKitDownload:allow-overwrite property

pub fn destination(&self) -> Option<GString>

Obtains the destination to which the downloaded file will be written.

You can connect to #WebKitDownload::created-destination to make sure this method returns a valid destination.

Returns

the destination or None

pub fn elapsed_time(&self) -> f64

Gets the elapsed time in seconds, including any fractional part.

If the download finished, had an error or was cancelled this is the time between its start and the event.

Returns

seconds since the download was started

pub fn estimated_progress(&self) -> f64

Gets the value of the #WebKitDownload:estimated-progress property. Gets the value of the #WebKitDownload:estimated-progress property. You can monitor the estimated progress of the download operation by connecting to the notify::estimated-progress signal of @self.

Returns

an estimate of the of the percent complete for a download as a range from 0.0 to 1.0.

pub fn received_data_length(&self) -> u64

Gets the length of the data already downloaded for @self.

Gets the length of the data already downloaded for @self in bytes.

Returns

the amount of bytes already downloaded.

pub fn request(&self) -> Option<URIRequest>

Retrieves the #WebKitURIRequest object that backs the download process.

Returns

the #WebKitURIRequest of @self

pub fn response(&self) -> Option<URIResponse>

Retrieves the #WebKitURIResponse object that backs the download process.

Retrieves the #WebKitURIResponse object that backs the download process. This method returns None if called before the response is received from the server. You can connect to notify::response signal to be notified when the response is received.

Returns

the #WebKitURIResponse, or None if the response hasn’t been received yet.

pub fn web_view(&self) -> Option<WebView>

Get the #WebKitWebView that initiated the download.

Returns

the #WebKitWebView that initiated @self, or None if @self was not initiated by a #WebKitWebView.

pub fn set_allow_overwrite(&self, allowed: bool)

Sets the #WebKitDownload:allow-overwrite property.

Sets the #WebKitDownload:allow-overwrite property, which determines whether the download may overwrite an existing file on disk, or if it will fail if the destination already exists.

allowed

the new value for the #WebKitDownload:allow-overwrite property

pub fn set_destination(&self, destination: &str)

Sets the destination to which the downloaded file will be written.

This method should be called before the download transfer starts or it will not have any effect on the ongoing download operation. To set the destination using the filename suggested by the server connect to #WebKitDownload::decide-destination signal and call webkit_download_set_destination(). If you want to set a fixed destination that doesn’t depend on the suggested filename you can connect to notify::response signal and call webkit_download_set_destination().

If #WebKitDownload::decide-destination signal is not handled and destination is not set when the download transfer starts, the file will be saved with the filename suggested by the server in G_USER_DIRECTORY_DOWNLOAD directory.

destination

the destination

pub fn connect_created_destination<F: Fn(&Self, &str) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted after #WebKitDownload::decide-destination and before #WebKitDownload::received-data to notify that destination file has been created successfully at @destination.

destination

the destination

pub fn connect_decide_destination<F: Fn(&Self, &str) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted after response is received to decide a destination for the download using webkit_download_set_destination(). If this signal is not handled, the file will be downloaded to G_USER_DIRECTORY_DOWNLOAD directory using @suggested_filename.

Since 2.40, you may handle this signal asynchronously by returning true without calling webkit_download_set_destination(). This indicates intent to eventually call webkit_download_set_destination(). In this case, the download will not proceed until the destination is set or cancelled with webkit_download_cancel().

suggested_filename

the filename suggested for the download

Returns

true to stop other handlers from being invoked for the event, or false to propagate the event further.

pub fn connect_failed<F: Fn(&Self, &Error) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when an error occurs during the download operation. The given @error, of the domain WEBKIT_DOWNLOAD_ERROR, contains further details of the failure. If the download is cancelled with webkit_download_cancel(), this signal is emitted with error DownloadError::CancelledByUser. The download operation finishes after an error and #WebKitDownload::finished signal is emitted after this one.

error

the #GError that was triggered

pub fn connect_finished<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

This signal is emitted when download finishes successfully or due to an error. In case of errors #WebKitDownload::failed signal is emitted before this one.

pub fn connect_received_data<F: Fn(&Self, u64) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted after response is received, every time new data has been written to the destination. It’s useful to know the progress of the download operation.

data_length

the length of data received in bytes

pub fn connect_allow_overwrite_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_destination_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_estimated_progress_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_response_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for Download

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Download

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Download

type ParamSpec = ParamSpecObject

type SetValue = Download

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Download>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Download

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Download

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Download

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Download

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Download

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Download

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Download