Struct Lock 

pub struct Lock { /* private fields */ }

The contents of leo.lock.

Implementations

impl Lock

pub fn read(dir: &Path) -> Self

Read the lock from dir, or an empty lock if it is missing. A malformed or unsupported-version lock is regenerated rather than erroring, but warns (unlike a missing file) so lost pins are visible.

pub fn commit_for(&self, name: &str, git: &str, reference: &str) -> Option<&str>

The pinned commit for (name, git, reference), or None (forcing re-resolution) on any mismatch.

pub fn commit_for_source(&self, git: &str, reference: &str) -> Option<&str>

The commit any dependency resolved (git, reference) to, regardless of name. Lets a build reuse a resolution it already performed for another dependency on the same repository.

pub fn record( &mut self, name: String, git: String, reference: String, commit: String, )

Record a pinned commit, replacing any existing entry for the same (name, git, reference). Entries under other references are kept: in a shared workspace lock they may belong to another member; stale ones are pruned by carry_over or leo remove.

pub fn carry_over( &mut self, old: &Lock, keep: impl FnMut(&GitLockEntry) -> bool, )

Carry over entries from old that were not re-recorded in this lock and that keep accepts.

pub fn remove_name(&mut self, name: &str)

Remove all entries pinning the dependency name.

pub fn write(&mut self, dir: &Path) -> Result<()>

Write the lock to dir, entries sorted for determinism. With no git dependencies, no file is written and a stale one is removed.

pub fn is_empty(&self) -> bool

Whether any git dependency is recorded.

Trait Implementations

impl Clone for Lock

fn clone(&self) -> Lock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lock

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

Formats the value using the given formatter.

impl Default for Lock

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Lock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Lock

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

where __S: Serializer,

Serialize this value into the given Serde serializer.