flox-flake.hh

Go to the documentation of this file.

/* ========================================================================== *
 *
 * @file flox/flox-flake.hh
 *
 * @brief Defines a convenience wrapper that provides various operations on
 *        a `flake`.
 *
 *
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <memory>
#include <nix/eval.hh>
#include <nix/flake/flake.hh>
#include <vector>
 
#include <nlohmann/json.hpp>
 
#include "flox/core/exceptions.hh"
#include "flox/core/nix-state.hh"
#include "flox/core/types.hh"
 
 
/* -------------------------------------------------------------------------- */
 
namespace flox {
 
/* -------------------------------------------------------------------------- */
 
static const nix::flake::LockFlags defaultLockFlags = {
  .recreateLockFile = false /* default */
  ,
  .updateLockFile = false,
  .writeLockFile  = false,
  .useRegistries  = std::nullopt /* default */
  ,
  .applyNixConfig = false /* default */
  ,
  .allowUnlocked = true /* default */
  ,
  .commitLockFile = false /* default */
  ,
  .referenceLockFilePath = std::nullopt /* default */
  ,
  .outputLockFilePath = std::nullopt /* default */
  ,
  .inputOverrides = {} /* default */
  ,
  .inputUpdates = {} /* default */
};
 
 
/* -------------------------------------------------------------------------- */
 
class FloxFlake : public std::enable_shared_from_this<FloxFlake>
{
 
private:
 
  std::shared_ptr<nix::eval_cache::EvalCache> _cache;
 
public:
 
  nix::ref<nix::EvalState>      state;
  const nix::flake::LockedFlake lockedFlake;
 
  FloxFlake( const nix::ref<nix::EvalState> & state,
             const nix::FlakeRef &            ref );
 
  nix::ref<nix::eval_cache::EvalCache>
  openEvalCache();
 
  MaybeCursor
  maybeOpenCursor( const AttrPath & path );
 
  Cursor
  openCursor( const AttrPath & path );
 
}; /* End class `FloxFlake' */
 
/* -------------------------------------------------------------------------- */
 
FLOX_DEFINE_EXCEPTION( LockFlakeException,
                       EC_NIX_LOCK_FLAKE,
                       "error locking flake" )
/* -------------------------------------------------------------------------- */
 
}  // namespace flox
 
 
/* -------------------------------------------------------------------------- *
 *
 *
 *
 * ========================================================================== */