#include <albert/asyncgeneratorqueryhandler.h>

Description

Coroutine-based asynchronous generator query handler.

Convenience base class for implementing triggered query handlers using C++ coroutines. Results are produced lazily via an asynchronous item generator. The items are displayed in the order they are yielded.

This class is suitable for I/O-bound query handling (e.g. network requests, subprocessing, etc.). For CPU-bound work, prefer GeneratorQueryHandler or its subclasses.

Warning: Coroutines are a powerful tool but they are also easy to misuse. Coroutine frames can be deleted at any suspension point. Responsibly manage your resources. RAII everything. Especially make sure no unmanaged memory is surpassing a suspension point!

Inheritance diagram for albert::AsyncGeneratorQueryHandler:

[legend]

Public Member Functions
virtual AsyncItemGenerator	items (QueryContext &context)=0
	Yields batches of items for context asynchronously and lazily.

Public Member Functions inherited from albert::QueryHandler
virtual QString	synopsis (const QString &query) const
	Returns the input hint for the given query.

virtual bool	allowTriggerRemap () const
	Returns `true` if the user is allowed to set a custom trigger, otherwise returns `false`.

virtual QString	defaultTrigger () const
	Returns the default trigger.

virtual bool	supportsFuzzyMatching () const
	Returns `true` if the handler supports fuzzy matching, otherwise returns `false`.

Public Member Functions inherited from albert::Extension
virtual QString	id () const =0
	Returns the extension identifier.

virtual QString	name () const =0
	Returns the pretty, human readable extension name.

virtual QString	description () const =0
	Returns the brief extension description.

Protected Member Functions
	~AsyncGeneratorQueryHandler () override
	Destructs the handler.

std::unique_ptr< QueryExecution >	execution (QueryContext &context) override
	Returns an asynchronous generator query execution for context.

Protected Member Functions inherited from albert::QueryHandler
	~QueryHandler () override
	Destructs the handler.

virtual void	setFuzzyMatching (bool enabled)
	Sets the fuzzy matching mode to enabled.

virtual void	setTrigger (const QString &trigger)
	Notifies that the user-defined trigger has changed to trigger.

Protected Member Functions inherited from albert::Extension
virtual	~Extension ()
	Destructs the extension.

Member Function Documentation

◆ items()

virtual AsyncItemGenerator albert::AsyncGeneratorQueryHandler::items ( QueryContext & context )

pure virtual

Yields batches of items for context asynchronously and lazily.

The batch size is defined by the implementation.

Note: GCC-13 does not support returning temporary values in generators. So for as long as Ubuntu 24.04 is supported, we have to return lvalues.; Called from main thread. Do not run blocking operations in it.

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

workspace/albert/include/albert/asyncgeneratorqueryhandler.h

Description

Public Member Functions

Protected Member Functions

Member Function Documentation

◆ items()