Struct Lockfile 

pub struct Lockfile {
    pub version: u32,
    pub created_at: DateTime<Utc>,
    pub toolchain: LockedToolchain,
    pub plan: LockedPlan,
    pub workspace: LockedWorkspace,
    pub packages: Vec<LockedPackage>,
}

The hx.lock lockfile.

Fields

version: u32

Lockfile format version

created_at: DateTime<Utc>

When the lockfile was created/updated

toolchain: LockedToolchain

Toolchain versions

plan: LockedPlan

Build plan metadata

workspace: LockedWorkspace

Workspace information (for multi-package projects)

packages: Vec<LockedPackage>

Locked packages (external dependencies)

Implementations

impl Lockfile

pub fn new() -> Self

Create a new empty lockfile.

pub fn parse(s: &str) -> Result<Self, LockError>

Parse a lockfile from a TOML string.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, LockError>

Parse a lockfile from a file.

pub fn to_string(&self) -> Result<String, LockError>

Serialize the lockfile to a TOML string.

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

Write the lockfile to a file.

pub fn fingerprint(&self) -> String

Calculate a fingerprint for the lockfile.

pub fn add_package(&mut self, pkg: LockedPackage)

Add a package to the lockfile.

pub fn set_toolchain(&mut self, ghc: Option<String>, cabal: Option<String>)

Set the toolchain versions.

pub fn set_snapshot(&mut self, snapshot: Option<String>)

Set the Stackage snapshot.

pub fn set_workspace(&mut self, packages: Vec<WorkspacePackageInfo>)

Set workspace information.

pub fn is_workspace(&self) -> bool

Check if this is a workspace lockfile.

pub fn workspace_package_names(&self) -> Vec<&str>

Get the workspace package names.

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 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.