Struct Lockfile

pub struct Lockfile<P: LockfilePermissions> { /* private fields */ }

A lockfile for an install tree

Implementations

impl<P: LockfilePermissions> Lockfile<P>

pub fn version(&self) -> &String

pub fn rocks(&self) -> &BTreeMap<LocalPackageId, LocalPackage>

pub fn is_dependency(&self, package: &LocalPackageId) -> bool

pub fn is_entrypoint(&self, package: &LocalPackageId) -> bool

pub fn entry_type(&self, package: &LocalPackageId) -> bool

pub fn get(&self, id: &LocalPackageId) -> Option<&LocalPackage>

pub unsafe fn get_unchecked(&self, id: &LocalPackageId) -> &LocalPackage

Unsafe because this assumes a prior check if the package is present

Safety

Ensure that the package is present in the lockfile before calling this function.

impl Lockfile<ReadOnly>

pub fn load( filepath: PathBuf, expected_rock_layout: Option<&RockLayoutConfig>, ) -> Result<Lockfile<ReadOnly>, LockfileError>

Load a Lockfile, failing if none exists. If expected_rock_layout is Some, this fails if the rock layouts don’t match

pub fn write_guard(self) -> LockfileGuard

Creates a lockfile guard, flushing the lockfile automatically once the guard goes out of scope.

pub fn map_then_flush<T, F, E>(self, cb: F) -> Result<T, E>

where F: FnOnce(&mut Lockfile<ReadWrite>) -> Result<T, E>, E: Error + From<Error>,

Converts the current lockfile into a writeable one, executes cb and flushes the lockfile.

Trait Implementations

impl<P: Clone + LockfilePermissions> Clone for Lockfile<P>

fn clone(&self) -> Lockfile<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + LockfilePermissions> Debug for Lockfile<P>

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

Formats the value using the given formatter.

impl<'de, P: LockfilePermissions> Deserialize<'de> for Lockfile<P>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: LockfilePermissions> Serialize for Lockfile<P>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl UserData for Lockfile<ReadOnly>

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.

impl UserData for Lockfile<ReadWrite>

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.