Struct Project

pub struct Project { /* private fields */ }

The main struct of the pesde library, representing a project

Implementations

impl Project

pub async fn download_graph( &self, graph: &DependencyGraph, refreshed_sources: &mut HashSet<PackageSources>, reqwest: &Client, prod: bool, write: bool, wally: bool, ) -> Result<(Receiver<Result<String, DownloadGraphError>>, Arc<Mutex<DownloadedGraph>>), DownloadGraphError>

Downloads a graph of dependencies

impl Project

pub async fn download_and_link<F: FnOnce(&Arc<DownloadedGraph>) -> R + Send + 'static, R: Future<Output = Result<(), E>> + Send, E: Send + Sync + 'static>( &self, graph: &Arc<DependencyGraph>, refreshed_sources: &Arc<Mutex<HashSet<PackageSources>>>, reqwest: &Client, prod: bool, write: bool, pesde_cb: F, ) -> Result<(DownloadAndLinkReceiver, impl Future<Output = Result<DownloadedGraph, DownloadAndLinkError<E>>>), DownloadAndLinkError<E>>

Downloads a graph of dependencies and links them in the correct order

impl Project

pub async fn link_dependencies( &self, graph: &DownloadedGraph, with_types: bool, ) -> Result<(), LinkingError>

Links the dependencies of the project

impl Project

pub async fn dependency_graph( &self, previous_graph: Option<&DependencyGraph>, refreshed_sources: &mut HashSet<PackageSources>, is_published_package: bool, ) -> Result<DependencyGraph, Box<DependencyGraphError>>

Create a dependency graph from the project’s manifest

impl Project

pub fn new<P: AsRef<Path>, Q: AsRef<Path>, R: AsRef<Path>, S: AsRef<Path>>( package_dir: P, workspace_dir: Option<Q>, data_dir: R, cas_dir: S, auth_config: AuthConfig, ) -> Self

Create a new Project

pub fn package_dir(&self) -> &Path

The directory of the package

pub fn workspace_dir(&self) -> Option<&Path>

The directory of the workspace this package belongs to, if any

pub fn data_dir(&self) -> &Path

The directory to store general-purpose data

pub fn auth_config(&self) -> &AuthConfig

The authentication configuration

pub fn cas_dir(&self) -> &Path

The CAS (content-addressable storage) directory

pub async fn read_manifest(&self) -> Result<String, ManifestReadError>

Read the manifest file

pub async fn deser_manifest(&self) -> Result<Manifest, ManifestReadError>

Deserialize the manifest file

pub async fn write_manifest<S: AsRef<[u8]>>( &self, manifest: S, ) -> Result<(), Error>

Write the manifest file

pub async fn deser_lockfile(&self) -> Result<Lockfile, LockfileReadError>

Deserialize the lockfile

pub async fn write_lockfile( &self, lockfile: Lockfile, ) -> Result<(), LockfileWriteError>

Write the lockfile

pub async fn workspace_members<P: AsRef<Path> + Debug>( &self, dir: P, can_ref_self: bool, ) -> Result<impl Stream<Item = Result<(PathBuf, Manifest), WorkspaceMembersError>>, WorkspaceMembersError>

Get the workspace members

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Project

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

Formats the value using the given formatter.