Skip to main content

FlakeLock

Struct FlakeLock 

Source
pub struct FlakeLock {
    pub nodes: BTreeMap<String, FlakeNode>,
    pub root: String,
    pub version: u32,
}
Expand description

A parsed and validated flake.lock file.

Fields§

§nodes: BTreeMap<String, FlakeNode>

All nodes keyed by their name.

§root: String

Name of the root node (usually "root").

§version: u32

Lock file schema version (must be 7).

Implementations§

Source§

impl FlakeLock

Source

pub fn parse(json: &str) -> Result<FlakeLock, FlakeLockError>

Parse a flake.lock from its JSON text.

Source

pub fn to_json(&self) -> Result<String, FlakeLockError>

Serialize the lock back to pretty-printed JSON.

Source

pub fn root_node(&self) -> Result<&FlakeNode, FlakeLockError>

Get the root node.

Source

pub fn get_node(&self, name: &str) -> Result<&FlakeNode, FlakeLockError>

Get a node by name.

Source

pub fn root_inputs(&self) -> Result<Vec<(String, String)>, FlakeLockError>

Return the direct inputs of the root node as (input_name, node_name) pairs, resolving follows along the way.

Source

pub fn resolve_ref( &self, _parent: &str, input_ref: &InputRef, ) -> Result<String, FlakeLockError>

Resolve an InputRef to a concrete node name.

  • Direct(name) simply returns name.
  • Follows(path) walks the path from the root node (Nix semantics: ["nixpkgs"] means “follow root’s nixpkgs input”; ["utils", "nixpkgs"] means “follow root -> utils -> nixpkgs”).
Source

pub fn resolve_input(&self, path: &[&str]) -> Result<&FlakeNode, FlakeLockError>

Walk the input graph from the root following a dotted-style path.

resolve_input(&["utils", "nixpkgs"]) starts at root, enters the utils input, then enters that node’s nixpkgs input, resolving any follows along the way.

Source

pub fn resolve_node_input( &self, node_name: &str, input_name: &str, ) -> Result<String, FlakeLockError>

Resolve one edge of the input graph: given the node name of a flake in the lock and the input name it declares, return the concrete node name that input resolves to — walking any follows redirection.

This is the load-bearing primitive for transitive-input resolution. CppNix pins a flake’s entire input closure in the ROOT lock’s node graph: a sub-flake’s inputs.substrate edge is stored on nodes[node] (as a direct node ref or a follows path rooted at the lock’s root), so the sub-flake’s OWN flake.lock is irrelevant once the root lock exists. A consumer that recurses into the sub-flake and re-reads its own lock resolves a different revision than nix (the sub-flake’s independent pin instead of the root’s follows target). Use this to resolve every transitive input against the one authoritative graph.

Source

pub fn node_input_edges(&self, node_name: &str) -> Vec<(String, String)>

Return the resolved (input_name, target_node_name) pairs for a node, in the lock’s declaration order (BTreeMap ⇒ deterministic).

Unresolvable edges (a follows into a missing sibling) are skipped — the caller falls back to a stub input, matching the pre-existing resolve-what-you-can behavior of evaluate_flake.

Source

pub fn adjacency_map(&self) -> BTreeMap<String, Vec<(String, String)>>

Build an adjacency list representation of the full input graph.

Returns node_name -> [(input_name, resolved_target_node)]. Follows are resolved; any unresolvable edges are silently skipped.

Trait Implementations§

Source§

impl Clone for FlakeLock

Source§

fn clone(&self) -> FlakeLock

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlakeLock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for FlakeLock

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<FlakeLock, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for FlakeLock

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more