nix::NixArgs Struct Reference

Inheritance diagram for nix::NixArgs:

Public Member Functions
AsyncIoRoot &	aio () override
	NixArgs (const std::string &programName, AsyncIoRoot &aio)
Strings::iterator	rewriteArgs (Strings &args, Strings::iterator pos) override
std::string	description () override
std::string	doc () override
void	run () override
void	pluginsInited () override
std::string	dumpCli ()
Public Member Functions inherited from nix::MultiCommand
	MultiCommand (const CommandMap &commands, bool allowExternal=false)
bool	processFlag (Strings::iterator &pos, Strings::iterator end) override
bool	processArgs (const Strings &args, bool finish) override
JSON	toJSON () override
Public Member Functions inherited from nix::Command
virtual std::optional< ExperimentalFeature >	experimentalFeature ()
virtual Category	category ()
Public Member Functions inherited from nix::Args
virtual bool	forceImpureByDefault ()
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)
RootArgs &	getRoot ()
Public Member Functions inherited from nix::MixCommonArgs
	MixCommonArgs (const std::string &programName)

Public Attributes
bool	useNet = true
bool	refresh = false
bool	helpRequested = false
bool	showVersion = false
AsyncIoRoot &	aio_
std::map< std::string, std::vector< std::string > >	aliases
bool	aliasUsed = false
Public Attributes inherited from nix::MultiCommand
CommandMap	commands
Strings	customCommandSearchPaths
bool	isExternalSubcommand
std::map< Command::Category, std::string >	categories
std::optional< std::pair< std::string, ref< Command > > >	command
Public Attributes inherited from nix::Args
MultiCommand *	parent = nullptr
Public Attributes inherited from nix::MixCommonArgs
std::string	programName

Additional Inherited Members
Public Types inherited from nix::Command
typedef int	Category
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 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()

Member Function Documentation

aio()

AsyncIoRoot & nix::NixArgs::aio ( )

inlineoverridevirtual

Implements nix::Args.

description()

std::string nix::NixArgs::description ( )

inlineoverridevirtual

Return a short one-line description of the command.

Reimplemented from nix::Args.

doc()

std::string nix::NixArgs::doc ( )

inlineoverridevirtual

Return documentation about this command, in Markdown format.

Reimplemented from nix::Args.

pluginsInited()

void nix::NixArgs::pluginsInited ( )

inlineoverridevirtual

Reimplemented from nix::MixCommonArgs.

rewriteArgs()

Strings::iterator nix::NixArgs::rewriteArgs ( Strings & args, Strings::iterator pos )

inlineoverridevirtual

Reimplemented from nix::Args.

run()

void nix::NixArgs::run ( )

inlineoverridevirtual

Entry point to the command

Implements nix::Command.

Member Data Documentation

aliases

std::map<std::string, std::vector<std::string> > nix::NixArgs::aliases

Initial value:

= {
        
        {"add-to-store", {"store", "add-path"}},
        {"cat-nar", {"nar", "cat"}},
        {"cat-store", {"store", "cat"}},
        {"copy-sigs", {"store", "copy-sigs"}},
        {"dev-shell", {"develop"}},
        {"diff-closures", {"store", "diff-closures"}},
        {"dump-path", {"store", "dump-path"}},
        {"hash-file", {"hash", "file"}},
        {"hash-path", {"hash", "path"}},
        {"ls-nar", {"nar", "ls"}},
        {"ls-store", {"store", "ls"}},
        {"make-content-addressable", {"store", "make-content-addressed"}},
        {"optimise-store", {"store", "optimise"}},
        {"ping-store", {"store", "ping"}},
        {"show-config", {"config", "show"}},
        {"show-derivation", {"derivation", "show"}},
        {"sign-paths", {"store", "sign"}},
        {"to-base16", {"hash", "to-base16"}},
        {"to-base32", {"hash", "to-base32"}},
        {"to-base64", {"hash", "to-base64"}},
        {"verify", {"store", "verify"}},
        
    }

---

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

• lix/nix/main.cc