SeqAn3
3.4.0
The Modern C++ library for sequence analysis.
Toggle main menu visibility
Loading...
Searching...
No Matches
on_result.hpp
Go to the documentation of this file.
1
// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin
2
// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik
3
// SPDX-License-Identifier: BSD-3-Clause
4
9
10
#pragma once
11
12
#include <
type_traits
>
13
14
#include <seqan3/contrib/std/detail/movable_box.hpp>
15
#include <
seqan3/core/configuration/pipeable_config_element.hpp
>
16
#include <
seqan3/search/configuration/detail.hpp
>
17
18
namespace
seqan3::search_cfg
19
{
20
50
template
<std::move_constructible callback_t>
51
class
on_result
:
private
seqan3::pipeable_config_element
52
{
53
public
:
55
seqan::stl::detail::movable_box_t<callback_t>
callback
;
// Allows lambdas with capture blocks.
56
60
constexpr
on_result
() =
default
;
61
constexpr
on_result
(
on_result
const
&) =
default
;
62
constexpr
on_result
(
on_result
&&) =
default
;
63
constexpr
on_result
&
operator=
(
on_result
const
&) =
default
;
64
constexpr
on_result
&
operator=
(
on_result
&&) =
default
;
65
~on_result
() =
default
;
66
70
constexpr
explicit
on_result
(callback_t &&
callback
) :
callback
{
std
::forward<callback_t>(
callback
)}
71
{}
72
73
76
static
constexpr
seqan3::detail::search_config_id
id
{seqan3::detail::search_config_id::on_result};
77
};
78
83
template
<std::move_constructible callback_t>
84
on_result
(callback_t &&) ->
on_result<std::decay_t<callback_t>
>;
86
}
// namespace seqan3::search_cfg
seqan3::search_cfg::on_result
Configuration element to provide a user defined callback function for the search.
Definition
on_result.hpp:52
seqan3::search_cfg::on_result::operator=
constexpr on_result & operator=(on_result const &)=default
Defaulted.
seqan3::search_cfg::on_result::on_result
constexpr on_result(callback_t &&callback)
Constructs the configuration element with the given user callback.
Definition
on_result.hpp:70
seqan3::search_cfg::on_result::on_result
constexpr on_result()=default
Defaulted.
seqan3::search_cfg::on_result::callback
seqan::stl::detail::movable_box_t< callback_t > callback
The stored callable which will be invoked with the search result.
Definition
on_result.hpp:55
seqan3::search_cfg::on_result::on_result
constexpr on_result(on_result &&)=default
Defaulted.
seqan3::search_cfg::on_result::on_result
constexpr on_result(on_result const &)=default
Defaulted.
seqan3::search_cfg::on_result::~on_result
~on_result()=default
Defaulted.
seqan3::search_cfg::on_result::operator=
constexpr on_result & operator=(on_result &&)=default
Defaulted.
seqan3::search_cfg
A special sub namespace for the search configurations.
seqan3::search_cfg::on_result
on_result(callback_t &&) -> on_result< std::decay_t< callback_t > >
Deduces the callback type from a forwarding constructor argument.
std
SeqAn specific customisations in the standard namespace.
pipeable_config_element.hpp
Provides seqan3::pipeable_config_element.
detail.hpp
Provides compatibility matrix for search configurations.
seqan3::pipeable_config_element
Adds pipe interface to configuration elements.
Definition
pipeable_config_element.hpp:29
type_traits
Hide me
Version:
seqan3
search
configuration
on_result.hpp
Generated on
for SeqAn3 by
1.17.0