Struct Lock 

pub struct Lock { /* private fields */ }

Implementations

impl Lock

pub fn from_resolution( resolution: &ResolverOutput, root: &Path, ) -> Result<Self, LockError>

Initialize a Lock from a ResolverOutput.

pub fn with_manifest(self, manifest: ResolverManifest) -> Self

Record the requirements that were used to generate this lock.

pub fn with_conflicts(self, conflicts: Conflicts) -> Self

Record the conflicting groups that were used to generate this lock.

pub fn with_supported_environments( self, supported_environments: Vec<MarkerTree>, ) -> Self

Record the supported environments that were used to generate this lock.

pub fn with_required_environments( self, required_environments: Vec<MarkerTree>, ) -> Self

Record the required platforms that were used to generate this lock.

pub fn supports_provides_extra(&self) -> bool

Returns true if this Lock includes provides-extra metadata.

pub fn includes_empty_groups(&self) -> bool

Returns true if this Lock includes entries for empty dependency-group metadata.

pub fn version(&self) -> u32

Returns the lockfile version.

pub fn revision(&self) -> u32

Returns the lockfile revision.

pub fn len(&self) -> usize

Returns the number of packages in the lockfile.

pub fn is_empty(&self) -> bool

Returns true if the lockfile contains no packages.

pub fn packages(&self) -> &[Package]

Returns the Package entries in this lock.

pub fn requires_python(&self) -> &RequiresPython

Returns the supported Python version range for the lockfile, if present.

pub fn resolution_mode(&self) -> ResolutionMode

Returns the resolution mode used to generate this lock.

pub fn prerelease_mode(&self) -> PrereleaseMode

Returns the pre-release mode used to generate this lock.

pub fn fork_strategy(&self) -> ForkStrategy

Returns the multi-version mode used to generate this lock.

pub fn exclude_newer(&self) -> ExcludeNewer

Returns the exclude newer setting used to generate this lock.

pub fn conflicts(&self) -> &Conflicts

Returns the conflicting groups that were used to generate this lock.

pub fn supported_environments(&self) -> &[MarkerTree]

Returns the supported environments that were used to generate this lock.

pub fn required_environments(&self) -> &[MarkerTree]

Returns the required platforms that were used to generate this lock.

pub fn members(&self) -> &BTreeSet<PackageName>

Returns the workspace members that were used to generate this lock.

pub fn requirements(&self) -> &BTreeSet<Requirement>

Returns the dependency groups that were used to generate this lock.

pub fn dependency_groups(&self) -> &BTreeMap<GroupName, BTreeSet<Requirement>>

Returns the dependency groups that were used to generate this lock.

pub fn build_constraints(&self, root: &Path) -> Constraints

Returns the build constraints that were used to generate this lock.

pub fn root(&self) -> Option<&Package>

Return the workspace root used to generate this lock.

pub fn simplified_supported_environments(&self) -> Vec<MarkerTree>

Returns the supported environments that were used to generate this lock.

The markers returned here are “simplified” with respect to the lock file’s requires-python setting. This means these should only be used for direct comparison purposes with the supported environments written by a human in pyproject.toml. (Think of “supported environments” in pyproject.toml as having an implicit and python_full_version >= '{requires-python-bound}' attached to each one.)

pub fn simplified_required_environments(&self) -> Vec<MarkerTree>

Returns the required platforms that were used to generate this lock.

pub fn simplify_environment(&self, marker: MarkerTree) -> MarkerTree

Simplify the given marker environment with respect to the lockfile’s requires-python setting.

pub fn fork_markers(&self) -> &[UniversalMarker]

If this lockfile was built from a forking resolution with non-identical forks, return the markers of those forks, otherwise None.

pub fn check_marker_coverage(&self) -> Result<(), (MarkerTree, MarkerTree)>

Checks whether the fork markers cover the entire supported marker space.

Returns the actually covered and the expected marker space on validation error.

pub fn requires_python_coverage( &self, new_requires_python: &RequiresPython, ) -> Result<(), (MarkerTree, MarkerTree)>

Checks whether the new requires-python specification is disjoint with the fork markers in this lock file.

If they are disjoint, then the union of the fork markers along with the given requires-python specification (converted to a marker tree) are returned.

When disjoint, the fork markers in the lock file should be dropped and not used.

pub fn to_toml(&self) -> Result<String, Error>

Returns the TOML representation of this lockfile.

pub fn find_by_name( &self, name: &PackageName, ) -> Result<Option<&Package>, String>

Returns the package with the given name. If there are multiple matching packages, then an error is returned. If there are no matching packages, then Ok(None) is returned.

pub async fn satisfies<Context: BuildContext>( &self, root: &Path, packages: &BTreeMap<PackageName, WorkspaceMember>, members: &[PackageName], required_members: &BTreeMap<PackageName, Editability>, requirements: &[Requirement], constraints: &[Requirement], overrides: &[Requirement], excludes: &[PackageName], build_constraints: &[Requirement], dependency_groups: &BTreeMap<GroupName, Vec<Requirement>>, dependency_metadata: &DependencyMetadata, indexes: Option<&IndexLocations>, tags: &Tags, markers: &MarkerEnvironment, hasher: &HashStrategy, index: &InMemoryIndex, database: &DistributionDatabase<'_, Context>, ) -> Result<SatisfiesResult<'_>, LockError>

Check whether the lock matches the project structure, requirements and configuration.

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<'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 PartialEq for Lock

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

impl StructuralPartialEq for Lock