SeqAn3 3.1.0
The Modern C++ library for sequence analysis.
on_result.hpp
Go to the documentation of this file.
1// -----------------------------------------------------------------------------------------------------
2// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
3// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
4// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6// -----------------------------------------------------------------------------------------------------
7
13#pragma once
14
15#include <type_traits>
16
17
21
22namespace seqan3::search_cfg
23{
24
54template <std::move_constructible callback_t>
56{
57public:
59 seqan3::semiregular_box_t<callback_t> callback{}; // Allow lambdas with capture block which are not copy_assignable.
60
64 constexpr on_result() = default;
65 constexpr on_result(on_result const &) = default;
66 constexpr on_result(on_result &&) = default;
67 constexpr on_result & operator=(on_result const &) = default;
68 constexpr on_result & operator=(on_result &&) = default;
69 ~on_result() = default;
70
74 constexpr explicit on_result(callback_t callback) : callback{std::forward<callback_t>(callback)}
75 {}
77
80 static constexpr seqan3::detail::search_config_id id{seqan3::detail::search_config_id::on_result};
81};
82
87template <std::move_constructible callback_t>
90} // namespace seqan3::search_cfg
Configuration element to provide a user defined callback function for the search.
Definition: on_result.hpp:56
constexpr on_result & operator=(on_result const &)=default
Defaulted.
seqan3::semiregular_box_t< callback_t > callback
The stored callable which will be invoked with the search result.
Definition: on_result.hpp:59
constexpr on_result()=default
Defaulted.
constexpr on_result(on_result &&)=default
Defaulted.
constexpr on_result(on_result const &)=default
Defaulted.
constexpr on_result(callback_t callback)
Constructs the configuration element with the given user callback.
Definition: on_result.hpp:74
~on_result()=default
Defaulted.
constexpr on_result & operator=(on_result &&)=default
Defaulted.
::ranges::semiregular_box_t semiregular_box_t
Utility transformation trait to get a wrapper type that models std::semiregular. Imported from ranges...
Definition: semiregular_box.hpp:35
A special sub namespace for the search configurations.
on_result(callback_t &&) -> on_result< std::decay_t< callback_t > >
Deduces the callback type from a forwarding constructor argument.
SeqAn specific customisations in the standard namespace.
Provides seqan3::pipeable_config_element.
Provides seqan3::semiregular_box.
Adds pipe interface to configuration elements.
Definition: pipeable_config_element.hpp:32