Enum forc_pkg::source::Source

pub enum Source {
    Member(Source),
    Git(Source),
    Path(Source),
    Ipfs(Source),
    Registry(Source),
}

Specifies a base source for a package.

• For registry packages, this includes a base version.
• For git packages, this includes a base git reference like a branch or tag.

Note that a Source does not specify a specific, pinned version. Rather, it specifies a source at which the current latest version may be located.

Variants

Member(Source)

Used to refer to a workspace member project.

Git(Source)

A git repo with a Forc.toml manifest at its root.

Path(Source)

A path to a directory with a Forc.toml manifest at its root.

Ipfs(Source)

A package described by its IPFS CID.

Registry(Source)

A forc project hosted on the official registry.

Implementations

impl Source

pub fn from_manifest_dep( manifest_dir: &Path, dep: &Dependency, member_manifests: &MemberManifestFiles ) -> Result<Self>

Convert the given manifest Dependency declaration to a Source.

pub fn from_manifest_dep_patched( manifest: &PackageManifestFile, dep_name: &str, dep: &Dependency, members: &MemberManifestFiles ) -> Result<Self>

Convert the given manifest Dependency declaration to a source, applying any relevant patches from within the given manifest as necessary.

pub fn apply_patch( &self, dep_name: &str, manifest: &PackageManifestFile, members: &MemberManifestFiles ) -> Result<Self>

If a patch exists for the dependency associated with this source within the given manifest, this returns a new Source with the patch applied.

If no patch exists, this returns the original Source.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Source

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Source

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

Feeds this value into the given Hasher.

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 Source

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Source

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

This method tests for self and other values to be equal, and is used by ==.

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 PartialOrd for Source

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

This method returns an ordering between self and other values if one exists.

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 Serialize for Source

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Source

impl StructuralEq for Source

impl StructuralPartialEq for Source