Struct DownloadManager 

pub struct DownloadManager {
    pub directory: PathBuf,
    pub persist: bool,
    /* private fields */
}

One managed download lifecycle for a browser.

Fields

directory: PathBuf

The directory downloads are saved into.

persist: bool

Whether files outlive the browser. Always true today.

Implementations

impl DownloadManager

pub fn create(options: DownloadOptions) -> Result<Arc<Self>, DownloadError>

Create a manager with a prepared download directory.

The directory is resolved and probed before a single download can start: a permission problem found afterwards looks exactly like a file that never arrived.

Arguments

• options - How downloads should be managed

Returns

A manager with no source attached yet.

Errors

Returns DownloadError::RelativeDirectory, DownloadError::DirectoryNotCreated or DownloadError::DirectoryNotWritable.

pub async fn attach( self: &Arc<Self>, transport: &dyn CdpTransport, ) -> Result<(), DownloadError>

Point a browser’s downloads at this manager.

Browser.setDownloadBehavior is browser-wide, which is what makes a download a person started observable too, and the directory watcher is what stands in for the event stream this crate’s CDP transport does not have.

Arguments

• transport - A CDP connection with Browser-domain access

Errors

Returns DownloadError::Transport when the browser refuses to redirect its downloads, which is how an attached browser that denies the Browser domain reports itself.

pub async fn attach_filesystem(self: &Arc<Self>) -> Result<(), DownloadError>

Watch the managed staging directory after a WebDriver launcher has configured its native download preferences. Does not send CDP commands.

pub fn list(&self) -> Vec<DownloadArtifact>

List every download seen in this session.

Returns

Artifacts in the order they started.

pub fn subscribe(&self) -> Receiver<DownloadArtifact>

Watch every download as it settles.

Returns

A receiver of settled artifacts, plus the started announcement.

pub async fn idle(&self)

Wait until every download the manager has seen has been placed.

pub async fn capture<F>( &self, options: CaptureOptions, action: F, ) -> Result<DownloadArtifact, DownloadError>

where F: Future<Output = Result<()>>,

Wait for a download, triggering it first.

The waiter and this capture’s naming rules are armed before action is awaited. A download can start, finish and be saved inside the action, so attaching them afterwards would save the file under the wrong name and skip the caller’s validation entirely.

Arguments

• options - Naming, validation, conflict policy and budget
• action - What triggers the download

Returns

The completed artifact.

Errors

Returns DownloadError::ActionFailed when the action itself failed, DownloadError::CaptureTimeout when nothing settled inside the budget, and DownloadError::DownloadFailed when the download failed or was cancelled — a capture never reports a file that is not there.

pub async fn dispose(&self)

Stop observing downloads.

Saved files are untouched: persistence is the point of the manager, so detaching must never be the thing that removes a user’s file.

Trait Implementations

impl Debug for DownloadManager

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

Formats the value using the given formatter.

impl DownloadSink for DownloadManager

fn started(&self, start: DownloadStart) -> String

Record a download the engine has just announced.

fn finished<'life0, 'async_trait>( &'life0 self, id: String, source: DownloadSource, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Place a finished download’s bytes under their final name.

fn failed(&self, id: String, kind: DownloadFailure, reason: String)

Record a download that ended without a file.