A set of query parameters. More...

#include <params.hh>

Public Member Functions
void	clear ()
	Reset to default state.

void	check () const
	Check validity of fields, throwing an exception if invalid.

pkgdb::PkgQueryArgs &	fillPkgQueryArgs (pkgdb::PkgQueryArgs &pqa) const
	Fill a flox::pkgdb::PkgQueryArgs struct with preferences to lookup packages filtered by SearchQuery requirements.

Detailed Description

A set of query parameters.

This is essentially a reorganized form of flox::pkgdb::PkgQueryArgs that is suited for JSON input.

Member Function Documentation

pkgdb::PkgQueryArgs & flox::search::SearchQuery::fillPkgQueryArgs ( pkgdb::PkgQueryArgs & pqa ) const

Fill a flox::pkgdb::PkgQueryArgs struct with preferences to lookup packages filtered by SearchQuery requirements.

NOTE: This DOES NOT clear pqa before filling it. This is intended to be used after filling pqa with global preferences.

Parameters

pqa	A set of query args to fill with preferences.

std::optional<std::string> flox::search::SearchQuery::name

Filter results by exact name.

std::optional<std::string> flox::search::SearchQuery::partialMatch

Filter results by partial match on pname, attrName, or description

std::optional<std::string> flox::search::SearchQuery::partialNameMatch

Filter results by partial match on pname or attrName

std::optional<std::string> flox::search::SearchQuery::pname

Filter results by exact pname.

std::optional<std::string> flox::search::SearchQuery::semver

Filter results by version range.

std::optional<std::string> flox::search::SearchQuery::version

Filter results by exact version.

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