Enum FlakeRefType 

#[non_exhaustive]
pub enum FlakeRefType {
    Resource(ResourceUrl),
    GitForge(GitForge),
    Indirect {
        id: String,
        ref_: Option<String>,
        rev: Option<String>,
        location: RefLocation,
    },
    Path {
        path: String,
        rev: Option<String>,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Resource(ResourceUrl)

A resource-style URL (git+, hg+, file+, tarball+); see ResourceUrl for the typed shape.

GitForge(GitForge)

A git-forge shorthand (github:, gitlab:, sourcehut:); see GitForge for the typed shape.

Indirect

Indirect (registry) flake reference, e.g. flake:nixpkgs or flake:nixpkgs/release-23.05.

Like GitForge, ref_ and rev are typed slots filled at parse time by inspecting the path-component value: 40-hex goes to rev, everything else to ref_. Nix’s indirect form accepts up to three segments flake:id/ref/rev; when both are present, both slots populate. location records whether a present value would render as flake:id/<value> or flake:id?ref=<value>.

Fields

id: String

ref_: Option<String>

rev: Option<String>

location: RefLocation

Path

Path must be a directory in the filesystem containing a flake.nix. Path must be an absolute path.

rev carries the optional 40-hex commit pin from a ?rev= query parameter. Nix accepts rev, narHash, revCount, and lastModified on path: URLs; narHash and the counts ride on crate::LocationParameters, but rev is a typed slot so locked store-path inputs round-trip without losing their pin. There is no path-component form for the rev (Path has no /<rev> shape in Nix’s grammar), so it always renders as ?rev=.

path: URLs may use the empty-authority form (path:///abs, equivalent to path:/abs) – Nix rejects only when the URL authority’s host is non-empty, so path://host/... errors but path:///abs parses. To preserve the internal byte-for-byte round-trip the empty-authority form is stored verbatim (leading // kept on path); the slash-collapse normalisation Nix performs at Display time is intentionally deferred.

Fields

path: String

rev: Option<String>

Trait Implementations

impl Clone for FlakeRefType

fn clone(&self) -> FlakeRefType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlakeRefType

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

Formats the value using the given formatter.

impl Default for FlakeRefType

Default is only the seed for the in-progress FlakeRef inside parse_nix_uri; an empty-path value is never round-trippable on its own (the empty-input guard rejects it before it can escape).

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FlakeRefType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FlakeRefType

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

Formats the value using the given formatter.

impl PartialEq for FlakeRefType

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FlakeRefType

impl StructuralPartialEq for FlakeRefType