#include <command.hh>
Public Member Functions | |
void | run () override |
ref< Store > | getStore () |
virtual ref< Store > | getDstStore () |
virtual ref< Store > | createStore () |
virtual void | run (ref< Store >)=0 |
![]() | |
virtual std::optional< ExperimentalFeature > | experimentalFeature () |
virtual Category | category () |
![]() | |
virtual std::string | description () |
virtual bool | forceImpureByDefault () |
virtual std::string | doc () |
virtual Path | getCommandBaseDir () const |
Get the base directory for the command. | |
void | addFlag (Flag &&flag) |
void | removeFlag (const std::string &longName) |
void | expectArgs (ExpectedArg &&arg) |
void | expectArg (const std::string &label, std::string *dest, bool optional=false) |
void | expectArg (const std::string &label, std::filesystem::path *dest, bool optional=false) |
void | expectArgs (const std::string &label, std::vector< std::string > *dest) |
virtual nlohmann::json | toJSON () |
RootArgs & | getRoot () |
Additional Inherited Members | |
![]() | |
using | Category = int |
![]() | |
MultiCommand * | parent = nullptr |
![]() | |
static constexpr Category | catDefault = 0 |
![]() | |
static CompleterFun | completePath |
static CompleterFun | completeDir |
![]() | |
using | CompleterFun = void(AddCompletions &, size_t, std::string_view) |
using | CompleterClosure = std::function<CompleterFun> |
![]() | |
virtual bool | processFlag (Strings::iterator &pos, Strings::iterator end) |
virtual bool | processArgs (const Strings &args, bool finish) |
virtual Strings::iterator | rewriteArgs (Strings &args, Strings::iterator pos) |
virtual void | initialFlagsProcessed () |
![]() | |
std::map< std::string, Flag::ptr > | longFlags |
std::map< char, Flag::ptr > | shortFlags |
std::list< ExpectedArg > | expectedArgs |
std::list< ExpectedArg > | processedArgs |
std::set< std::string > | hiddenCategories |
![]() | |
static const size_t | ArityAny = std::numeric_limits<size_t>::max() |
A command that requires a Nix store.
Return the destination Nix store.
Reimplemented in nix::CopyCommand.
|
overridevirtual |
Entry point to the command
Implements nix::Command.
Main entry point, with a Store
provided
Implemented in CmdAddDerivation, CmdAddToStore, CmdCatNar, CmdCatStore, CmdConfigCheck, CmdDiffClosures, CmdFlakeArchive, CmdFlakeCheck, CmdFlakeClone, CmdFlakeInfo, CmdFlakeInitCommon, CmdFlakeLock, CmdFlakeMetadata, CmdFlakePrefetch, CmdFlakeShow, CmdFlakeUpdate, CmdFmt, CmdInfoStore, CmdLsStore, CmdOptimiseStore, CmdPathFromHashPart, CmdPingStore, CmdProfileDiffClosures, CmdProfileHistory, CmdProfileList, CmdProfileRemove, CmdProfileRollback, CmdProfileUpgrade, CmdProfileWipeHistory, CmdRegistryList, CmdRegistryPin, CmdRun, CmdStoreGC, CmdStorePrefetchFile, CmdUpgradeNix, CmdWhyDepends, nix::InstallableCommand, and nix::RawInstallablesCommand.