#include <command.hh>
Public Member Functions | |
| void | run () override |
| ref< Store > | getStore () |
| virtual ref< Store > | createStore () |
| virtual void | run (ref< Store >)=0 |
| Public Member Functions inherited from nix::Command | |
| virtual std::optional< ExperimentalFeature > | experimentalFeature () |
| virtual Category | category () |
| Public Member Functions inherited from nix::Args | |
| virtual std::string | description () |
| virtual bool | forceImpureByDefault () |
| virtual std::string | doc () |
| virtual AsyncIoRoot & | aio ()=0 |
| 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 | expectArgs (const std::string &label, std::vector< std::string > *dest) |
| virtual JSON | toJSON () |
| RootArgs & | getRoot () |
Additional Inherited Members | |
| Public Types inherited from nix::Command | |
| typedef int | Category |
| Public Attributes inherited from nix::Args | |
| MultiCommand * | parent = nullptr |
| Static Public Attributes inherited from nix::Command | |
| static constexpr Category | catDefault = 0 |
| static constexpr Category | catCustom = 1000 |
| Static Public Attributes inherited from nix::Args | |
| static CompleterFun | completePath |
| static CompleterFun | completeDir |
| Protected Types inherited from nix::Args | |
| typedef void | CompleterFun(AddCompletions &, size_t, std::string_view) |
| typedef std::function< CompleterFun > | CompleterClosure |
| Protected Member Functions inherited from nix::Args | |
| 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 () |
| virtual std::optional< std::reference_wrapper< RootArgs > > | asRootArgs () |
| Protected Attributes inherited from nix::Args | |
| 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 Protected Attributes inherited from nix::Args | |
| static const size_t | ArityAny = std::numeric_limits<size_t>::max() |
Detailed Description
A command that requires a Nix store.
Member Function Documentation
◆ run() [1/2]
|
overridevirtual |
Entry point to the command
Implements nix::Command.
◆ run() [2/2]
Main entry point, with a Store provided
Implemented in nix::CmdAddDerivation, nix::CmdAddToStore, nix::CmdCatNar, nix::CmdCatStore, nix::CmdDaemon, nix::CmdDiffClosures, nix::CmdDoctor, nix::CmdFlakeArchive, nix::CmdFlakeCheck, nix::CmdFlakeClone, nix::CmdFlakeInfo, nix::CmdFlakeInitCommon, nix::CmdFlakeLock, nix::CmdFlakeMetadata, nix::CmdFlakePrefetch, nix::CmdFlakeShow, nix::CmdFlakeUpdate, nix::CmdFmt, nix::CmdLsStore, nix::CmdOptimiseStore, nix::CmdPathFromHashPart, nix::CmdPingStore, nix::CmdProfileDiffClosures, nix::CmdProfileHistory, nix::CmdProfileList, nix::CmdProfileRemove, nix::CmdProfileRollback, nix::CmdProfileUpgrade, nix::CmdProfileWipeHistory, nix::CmdRegistryList, nix::CmdRegistryPin, nix::CmdRun, nix::CmdStoreGC, nix::CmdStorePrefetchFile, nix::CmdUpgradeNix, nix::CmdWhyDepends, nix::InstallableCommand, and nix::RawInstallablesCommand.
The documentation for this struct was generated from the following files:
- lix/libcmd/command.hh
- lix/libcmd/command.cc
