Enum LockEntry 

#[non_exhaustive]
pub enum LockEntry {
    Http(HttpLockEntry),
    Git(GitLockEntry),
    Private(PrivateLockEntry),
}

A lock entry for a dependency.

A builder should be used to create the underlying HttpLockEntry or GitLockEntry and then converted into this type with .into().

Examples

let dep: LockEntry = HttpLockEntry::builder()
    .name("my-dep")
    .version("1.2.3")
    .url("https://...")
    .checksum("dead")
    .integrity("beef")
    .build()
    .into();

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Http(HttpLockEntry)

A lock entry for an HTTP dependency.

Git(GitLockEntry)

A lock entry for a git dependency.

Private(PrivateLockEntry)

A lock entry for a git dependency.

Implementations

impl LockEntry

pub fn name(&self) -> &str

The name of the dependency.

pub fn version(&self) -> &str

The version of the dependency.

pub fn install_path(&self, deps: impl AsRef<Path>) -> PathBuf

The install path of the dependency.

pub fn as_http(&self) -> Option<&HttpLockEntry>

Get the underlying HttpLockEntry if this is an HTTP lock entry.

pub fn as_git(&self) -> Option<&GitLockEntry>

Get the underlying GitLockEntry if this is a git lock entry.

pub fn as_private(&self) -> Option<&PrivateLockEntry>

Get the underlying PrivateLockEntry if this is a private package lock entry.

Trait Implementations

impl Clone for LockEntry

fn clone(&self) -> LockEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockEntry

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

Formats the value using the given formatter.

impl From<GitLockEntry> for LockEntry

fn from(value: GitLockEntry) -> Self

Wrap a GitLockEntry in a LockEntry.

impl From<HttpLockEntry> for LockEntry

fn from(value: HttpLockEntry) -> Self

Wrap an HttpLockEntry in a LockEntry.

impl From<LockEntry> for TomlLockEntry

fn from(value: LockEntry) -> Self

Convert a LockEntry into a TomlLockEntry.

impl From<PrivateLockEntry> for LockEntry

fn from(value: PrivateLockEntry) -> Self

Wrap a PrivateLockEntry in a LockEntry.

impl Hash for LockEntry

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 PartialEq for LockEntry

fn eq(&self, other: &LockEntry) -> 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 TryFrom<TomlLockEntry> for LockEntry

fn try_from(value: TomlLockEntry) -> Result<Self, Self::Error>

Convert a TomlLockEntry into a LockEntry if possible.

type Error = LockError

The type returned in the event of a conversion error.

impl Eq for LockEntry

impl StructuralPartialEq for LockEntry