Nix 2.26.3
Nix, the purely functional package manager; unstable internal interfaces
 
Loading...
Searching...
No Matches
CmdRegistry Struct Reference
Inheritance diagram for CmdRegistry:
nix::NixMultiCommand nix::MultiCommand nix::Command nix::Args nix::Args

Public Member Functions

std::string description () override
 
std::string doc () override
 
Category category () override
 
- Public Member Functions inherited from nix::NixMultiCommand
nlohmann::json toJSON () override
 
virtual void run () override
 
 MultiCommand (std::string_view commandName, const Commands &commands)
 
- Public Member Functions inherited from nix::MultiCommand
 MultiCommand (std::string_view commandName, const Commands &commands)
 
bool processFlag (Strings::iterator &pos, Strings::iterator end) override
 
bool processArgs (const Strings &args, bool finish) override
 
- Public Member Functions inherited from nix::Args
virtual bool forceImpureByDefault ()
 
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)
 
RootArgsgetRoot ()
 
- Public Member Functions inherited from nix::Command
virtual std::optional< ExperimentalFeatureexperimentalFeature ()
 

Additional Inherited Members

- Public Types inherited from nix::Command
using Category = int
 
- Public Attributes inherited from nix::MultiCommand
Commands commands
 
std::map< Command::Category, std::string > categories
 
std::optional< std::pair< std::string, ref< Command > > > command
 
- Public Attributes inherited from nix::Args
MultiCommandparent = nullptr
 
- Static Public Attributes inherited from nix::Args
static CompleterFun completePath
 
static CompleterFun completeDir
 
- Static Public Attributes inherited from nix::Command
static constexpr Category catDefault = 0
 
- Protected Types inherited from nix::Args
using CompleterFun = void(AddCompletions &, size_t, std::string_view)
 
using CompleterClosure = std::function<CompleterFun>
 
- Protected Member Functions inherited from nix::Args
virtual Strings::iterator rewriteArgs (Strings &args, Strings::iterator pos)
 
virtual void initialFlagsProcessed ()
 
- Protected Attributes inherited from nix::MultiCommand
std::string commandName = ""
 
- Protected Attributes inherited from nix::Args
std::map< std::string, Flag::ptr > longFlags
 
std::map< char, Flag::ptr > shortFlags
 
std::list< ExpectedArgexpectedArgs
 
std::list< ExpectedArgprocessedArgs
 
std::set< std::string > hiddenCategories
 
- Static Protected Attributes inherited from nix::Args
static const size_t ArityAny = std::numeric_limits<size_t>::max()
 

Member Function Documentation

◆ category()

Category CmdRegistry::category ( )
inlineoverridevirtual

Reimplemented from nix::Command.

◆ description()

std::string CmdRegistry::description ( )
inlineoverridevirtual

Return a short one-line description of the command.

Reimplemented from nix::Args.

◆ doc()

std::string CmdRegistry::doc ( )
inlineoverridevirtual

Return documentation about this command, in Markdown format.

Reimplemented from nix::Args.


The documentation for this struct was generated from the following file: