Enum DepIdentifier 

pub enum DepIdentifier {
    Branch {
        name: String,
        rev: String,
        override: bool,
    },
    Tag {
        name: String,
        rev: String,
        override: bool,
    },
    Rev {
        rev: String,
        override: bool,
    },
}

Identifies whether a dependency (submodule) is referenced by a branch, tag or rev (commit hash).

Each enum variant consists of an r#override flag which is used in forge update to decide whether to update a dep or not. This flag is skipped during serialization.

Variants

Branch

name of the branch and the rev it is currently pointing to. Running forge update, will update the name branch to the latest rev.

Fields

name: String

rev: String

override: bool

Tag

Release tag name and the rev it is currently pointing to. Running forge update does not update the tag/rev. Dependency will remain pinned to the existing tag/rev unless r#override like so forge update owner/dep@tag=different_tag.

Fields

name: String

rev: String

override: bool

Rev

Commit hash rev the submodule is currently pointing to. Running forge update does not update the rev. Dependency will remain pinned to the existing rev unless r#override.

Fields

rev: String

override: bool

Implementations

impl DepIdentifier

pub fn resolve_type(git: &Git<'_>, lib_path: &Path, s: &str) -> Result<Self>

Resolves the DepIdentifier for a submodule at a given path. lib_path is the absolute path to the submodule.

pub fn rev(&self) -> &str

Get the commit hash of the dependency.

pub fn name(&self) -> &str

Get the name of the dependency.

In case of a Rev, this will return the commit hash.

pub fn checkout_id(&self) -> &str

Get the name/rev to checkout at.

pub fn mark_override(&mut self)

Marks as dependency as overridden.

pub fn overridden(&self) -> bool

Returns whether the dependency has been overridden.

pub fn is_branch(&self) -> bool

Returns whether the dependency is a branch.

Trait Implementations

impl Clone for DepIdentifier

fn clone(&self) -> DepIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DepIdentifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DepIdentifier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DepIdentifier

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

Formats the value using the given formatter.

impl PartialEq for DepIdentifier

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DepIdentifier

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 DepIdentifier

impl StructuralPartialEq for DepIdentifier

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes

Size for each variant:

• Branch: 55 bytes
• Tag: 55 bytes
• Rev: 31 bytes