aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/fef/verify_feature.h
blob: 9f048084c036440bf602c3bfa51f2da34f53e258 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include <vespa/vespalib/stllike/string.h>
#include <vector>

namespace search::fef {

class BlueprintFactory;
class IIndexEnvironment;

enum class Level {INFO, WARNING, ERROR};
using Message = std::pair<Level, vespalib::string>;

/**
 * Verify whether a specific feature can be computed. If the feature
 * can not be computed, log a reason why, including feature
 * dependencies.
 *
 * @return true if the feature can be computed, false otherwise
 * @param factory blueprint factory
 * @param indexEnv index environment
 * @param featureName name of feature to verify
 * @param desc external description of the feature
 **/
bool verifyFeature(const BlueprintFactory &factory,
                   const IIndexEnvironment &indexEnv,
                   const std::string &featureName,
                   const std::string &desc,
                   std::vector<Message> & errors);

}