Skip to main content

NixAttrs

Struct NixAttrs 

Source
pub struct NixAttrs(/* private fields */);
Expand description

A Nix attribute set with lazy overlay support.

Internally uses either a concrete compact AttrsMap or a lazy overlay chain. The // operator creates O(1) overlay nodes instead of O(m log n) merges. Attribute access walks the chain right-to-left in O(depth). Full iteration (attrNames, attrValues) flattens on demand.

The second tuple field is an OPTIONAL source-position table (None for the vast majority of attrsets — merges, overlays, builtin-built, dynamic keys). eval_attrset attaches it for a literal with static keys so builtins.unsafeGetAttrPos can report a key’s file/line/column (the attrTag declarations — options.json dock root). It is behind Rc, so a clone is a refcount bump; None costs one pointer-sized word.

Implementations§

Source§

impl NixAttrs

Source

pub fn new() -> Self

Source

pub fn with_capacity(_capacity: usize) -> Self

Source

pub fn set_positions(&mut self, pos: Rc<AttrPositions>)

Attach a source-position table (the static keys’ byte offsets of the literal that built this attrset). Called by eval_attrset; consumed by builtins.unsafeGetAttrPos. Never affects any observed value.

Source

pub fn positions(&self) -> Option<&Rc<AttrPositions>>

The source-position table, if this attrset carries one (a literal with static keys). None for merges/overlays/builtin-built/dynamic-key attrsets.

Source

pub fn pos_for(&self, key: &str) -> Option<ResolvedPos>

Resolve the source position of key in this attrset — the file/line/ column builtins.unsafeGetAttrPos returns. None when the attrset has no position table, the key is absent from it, or the source has no file (a <string>-eval’d literal).

Source

pub fn inner(&self) -> AttrsMap<Symbol, Value>

Borrow the underlying map. Flattens if overlay.

Source

pub fn get(&self, key: &str) -> Option<&Value>

Look up an attribute by name. Walks overlay chain right-to-left.

Source

pub fn get_sym(&self, sym: &Symbol) -> Option<&Value>

Look up by pre-interned Symbol.

Fast path: if the overlay’s flat cache has been populated (by any prior full iteration — attrNames, attrValues, // merge that needed key enumeration, etc.), read directly from it in O(1). This matters in real Nix workloads where an attrset is first iterated (module eval, with desugaring) and then hit many times by dotted access — CppNix has no such structure and pays O(1) always; we want to match that whenever the cache is warm.

Slow path: walk the overlay chain right-to-left in O(depth). Not populating the cache on cold lookups is deliberate — the cache costs O(n) to build and the chain is usually short (1–3 overlays).

Source

pub fn insert(&mut self, key: String, value: Value)

Insert or overwrite an attribute. Flattens overlay if needed.

Source

pub fn contains_key(&self, key: &str) -> bool

Source

pub fn contains_key_sym(&self, sym: &Symbol) -> bool

Source

pub fn keys(&self) -> impl Iterator<Item = String>

Source

pub fn iter(&self) -> impl Iterator<Item = (String, &Value)>

Source

pub fn iter_unsorted(&self) -> impl Iterator<Item = (String, &Value)>

Source

pub fn iter_syms(&self) -> impl Iterator<Item = (Symbol, &Value)>

Sym-keyed unsorted iteration — ZERO interner traffic, zero allocation.

This exists because live-sampling the cid marquee eval (2026-07-21, release-profiling binary) showed the interner round-trip as the #1 CPU sink — 27–39% of the eval thread, sustained: iter_unsorted above materializes a fresh heap String per key via resolve AND collects the whole map into a Vec on every call, and callers like intersectAttrs then re-intern each of those Strings straight back to the Symbol they started as (contains_key(&str)intern), with a third intern inside insert. Sym→String→hash+memcmp→Sym, three times per key per call, at nixpkgs scale.

Symbol is Copy(u32) and as_flat() hands back a real borrow (the Overlay case populates its cache), so this iterator borrows instead of collecting. Byte-neutral by the same argument already sealed for the unsorted-iteration change: the observable order of any result attrset is re-derived at observation time via sorted_entries.

Source

pub fn insert_sym(&mut self, sym: Symbol, value: Value)

Sym-keyed insert — the zero-intern sibling of insert, for callers that already hold the Symbol (every iter_syms consumer).

Source

pub fn values(&self) -> impl Iterator<Item = &Value>

Source

pub fn remove(&mut self, key: &str) -> Option<Value>

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn overlay(self, other: NixAttrs) -> NixAttrs

O(1) lazy overlay: self // other. Does NOT merge eagerly.

Source

pub fn update(&self, other: &NixAttrs) -> NixAttrs

Eager merge (legacy API — prefer overlay for //).

Trait Implementations§

Source§

impl Clone for NixAttrs

Source§

fn clone(&self) -> Self

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 NixAttrs

Source§

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

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

impl Default for NixAttrs

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for NixAttrs

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl From<NixAttrs> for Value

Source§

fn from(attrs: NixAttrs) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<(String, Value)> for NixAttrs

Source§

fn from_iter<I: IntoIterator<Item = (String, Value)>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl IntoIterator for NixAttrs

Source§

type Item = (String, Value)

The type of the elements being iterated over.
Source§

type IntoIter = Box<dyn Iterator<Item = (String, Value)>>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. 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> 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