////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2016-2016 ArangoDB GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Michael Hackstein
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_AQL_TRAVERSAL_OPTIONS_H
#define ARANGOD_AQL_TRAVERSAL_OPTIONS_H 1

#include "Basics/Common.h"
#include "VocBase/Traverser.h"

#include <velocypack/Slice.h>

namespace arangodb {
namespace aql {

/// @brief TraversalOptions
struct TraversalOptions {

  /// @brief constructor
  explicit TraversalOptions(arangodb::velocypack::Slice const&);

  /// @brief constructor, using default values
  TraversalOptions()
      : useBreadthFirst(false),
        uniqueVertices(traverser::TraverserOptions::UniquenessLevel::NONE),
        uniqueEdges(traverser::TraverserOptions::UniquenessLevel::PATH) {}

  void toVelocyPack(arangodb::velocypack::Builder&) const;

  bool useBreadthFirst;
  traverser::TraverserOptions::UniquenessLevel uniqueVertices;
  traverser::TraverserOptions::UniquenessLevel uniqueEdges;
};

}  // namespace arangodb::aql
}  // namespace arangodb
#endif