Struct Lockfile 

pub struct Lockfile {
    pub version: u32,
    pub pkg: Vec<LockedPkg>,
}

Root structure of mlua-pkg.lock.

Use Lockfile::read to load an existing lockfile and Lockfile::write to persist one. Lockfile::default creates an empty lockfile with version = 1.

Unknown top-level keys cause an immediate parse error (#[serde(deny_unknown_fields)]).

Fields

version: u32

Schema version. Always 1 in this implementation.

Future tooling may bump this number and apply a migration before deserializing the rest of the file.

pkg: Vec<LockedPkg>

Locked package entries. Written as [[pkg]] in TOML.

May be empty for a newly-initialized lockfile (no deps installed yet).

Implementations

impl Lockfile

pub fn read(path: impl AsRef<Path>) -> Result<Self, PkgError>

Read and parse a mlua-pkg.lock file at path.

Errors

Error	Condition
PkgError::MissingLockfile	File does not exist
PkgError::LockfileParse	Invalid TOML or unknown / missing fields
PkgError::SameNameConflict	Duplicate name in [[pkg]] entries
PkgError::Io	Other I/O failure

pub fn write(&self, path: impl AsRef<Path>) -> Result<(), PkgError>

Write the lockfile to path.

Packages are sorted by name before writing to produce diff-stable output suitable for version control.

This implementation uses fs::write (not atomic). Atomic write via tempfile::NamedTempFile::persist is a planned enhancement for a future subtask.

Errors

Error	Condition
PkgError::LockfileWrite	TOML serialization failed
PkgError::Io	File write failed

Trait Implementations

impl Clone for Lockfile

fn clone(&self) -> Lockfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lockfile

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

Formats the value using the given formatter.

impl Default for Lockfile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Lockfile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Lockfile

impl PartialEq for Lockfile

fn eq(&self, other: &Lockfile) -> 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 Lockfile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Lockfile