1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
pub mod git;
pub mod hg;
pub mod svn;
use std::path::Path;
use anyhow::Result;
/// The VCS downloader interface.
///
/// Corresponds to Composer's `VcsDownloader` hierarchy.
pub trait VcsDownloader {
/// Prepare for installation (e.g., sync mirror cache).
fn download(&self, url: &str, reference: &str, target: &Path) -> Result<()>;
/// Install (clone/checkout) the source to the target directory.
fn install(&self, url: &str, reference: &str, target: &Path) -> Result<()>;
/// Update the source at target to a new reference.
fn update(&self, url: &str, old_ref: &str, new_ref: &str, target: &Path) -> Result<()>;
/// Remove the source from the target directory.
fn remove(&self, target: &Path) -> Result<()>;
/// Detect local changes in the working copy.
/// Returns `None` if clean, `Some(diff)` if modified.
/// Mirrors `Composer\Downloader\ChangeReportInterface::getLocalChanges`.
fn get_local_changes(&self, target: &Path) -> Result<Option<String>>;
/// Detect commits present locally but not on the tracking remote.
/// Returns `None` if there are no unpushed commits or the concept does
/// not apply (only `GitDownloader` implements this in Composer's
/// `DvcsDownloaderInterface`).
fn unpushed_changes(&self, _target: &Path) -> Result<Option<String>> {
Ok(None)
}
/// Resolve the working copy's current VCS reference (e.g. commit hash).
/// Returns `None` if no reference can be determined. Mirrors
/// `Composer\Downloader\VcsCapableDownloaderInterface::getVcsReference`.
fn vcs_reference(&self, _target: &Path) -> Result<Option<String>> {
Ok(None)
}
/// Get commit log between two references.
fn commit_logs(&self, from: &str, to: &str, target: &Path) -> Result<String>;
/// instanceof ChangeReportInterface
fn is_change_report(&self) -> bool;
/// instanceof VcsCapableDownloaderInterface
fn is_vcs_capable_downloader(&self) -> bool;
/// instanceof DvcsDownloaderInterface
fn is_dvcs_downloader(&self) -> bool;
}
|