nix::MixFlakeOptions Struct Reference

#include <command.hh>

Inheritance diagram for nix::MixFlakeOptions:

Collaboration diagram for nix::MixFlakeOptions:

Public Member Functions
virtual std::vector< FlakeRef >	getFlakeRefsForCompletion ()
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 ()
Public Member Functions inherited from nix::EvalCommand
ref< Store >	getEvalStore ()
virtual ref< eval_cache::CachingEvaluator >	getEvaluator ()
Public Member Functions inherited from nix::StoreCommand
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::MixEvalArgs
Bindings *	getAutoArgs (Evaluator &state)

Public Attributes
flake::LockFlags	lockFlags
Public Attributes inherited from nix::Args
MultiCommand *	parent = nullptr
Public Attributes inherited from nix::EvalCommand
bool	startReplOnEvalErrors = false
bool	ignoreExceptionsDuringTry = false
Public Attributes inherited from nix::MixEvalArgs
SearchPath	searchPath
std::optional< std::string >	evalStoreUrl
Public Attributes inherited from nix::MixRepair
RepairFlag	repair = NoRepair

Additional Inherited Members
Public Types inherited from nix::Command
typedef int	Category
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
static constexpr Category	catCustom = 1000
Static Public Attributes inherited from nix::MixEvalArgs
static constexpr auto	category = "Common evaluation options"
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 mixin class for commands that process flakes, adding a few standard flake-related options/flags.

Member Function Documentation

getFlakeRefsForCompletion()

virtual std::vector< FlakeRef > nix::MixFlakeOptions::getFlakeRefsForCompletion ( )

inlinevirtual

The completion for some of these flags depends on the flake(s) in question.

This method should be implemented to gather all flakerefs the command is operating with (presumably specified via some other arguments) so that the completions for these flags can use them.

Reimplemented in nix::RawInstallablesCommand, nix::InstallableCommand, and nix::FlakeCommand.

---

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

• lix/libcmd/command.hh
• lix/libcmd/installables.cc