Download

Struct Download 

Source
pub struct Download { /* private fields */ }
Expand description

A file download.

Downloads are emitted via the page.on_download() callback or can be obtained using page.wait_for_download().

§Example


// Downloads are obtained like this:
// let download = page.wait_for_download(async {
//     page.locator("a.download").click().await?;
//     Ok(())
// }).await?;
//
// // Get the downloaded file path
// let path = download.path().await?;
// println!("Downloaded to: {}", path.display());
//
// // Or save to a custom location
// download.save_as("./downloads/my-file.pdf").await?;

Implementations§

Source§

impl Download

Source

pub fn url(&self) -> &str

Get the download URL.

Source

pub fn suggested_filename(&self) -> &str

Get the suggested filename from the browser.

This is the filename that the browser suggested based on the Content-Disposition header or URL.

Source

pub fn guid(&self) -> &str

Get the global unique identifier of this download.

Source

pub async fn path(&mut self) -> Result<PathBuf, NetworkError>

Get the path to the downloaded file.

This method waits for the download to complete if it’s still in progress. The file is saved to a temporary location by default.

§Errors

Returns an error if the download fails or is canceled.

Source

pub async fn save_as( &mut self, dest: impl AsRef<Path>, ) -> Result<(), NetworkError>

Save the downloaded file to a custom location.

This method waits for the download to complete if it’s still in progress, then copies the file to the specified path.

§Errors

Returns an error if:

  • The download fails or is canceled
  • The file cannot be copied to the destination
Source

pub async fn cancel(&mut self) -> Result<(), NetworkError>

Cancel the download.

This method cancels an in-progress download. If the download has already completed, this has no effect.

Source

pub fn failure(&self) -> Option<&str>

Get the failure reason if the download failed.

Returns None if the download completed successfully or is still in progress.

Trait Implementations§

Source§

impl Debug for Download

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more