Tesseract 0.28.4
Loading...
Searching...
No Matches
yaml_utils.h File Reference

YAML Type conversions. More...

#include <string>
#include <set>
#include <filesystem>

Namespaces

namespace  tesseract::common
 Namespace owning boost's hash_is_avalanching, and defined iff boost has the trait at all.
 

Functions

void tesseract::common::processYamlIncludeDirective (YAML::Node &node, const ResourceLocator &locator)
 Recursively expands !include directives in a YAML node, in-place.
 
YAML::Node tesseract::common::loadYamlFile (const std::string &file_path, const ResourceLocator &locator)
 Loads a YAML file and processes !include directives recursively.
 
YAML::Node tesseract::common::loadYamlString (const std::string &yaml_string, const ResourceLocator &locator)
 
void tesseract::common::writeYamlToFile (const YAML::Node &node, const std::string &file_path)
 Writes a YAML::Node to a file.
 
void tesseract::common::checkForUnknownKeys (const YAML::Node &node, const std::set< std::string > &expected_keys)
 Check node map for unknown keys.
 
std::string tesseract::common::toYAMLString (const YAML::Node &node)
 Converts a YAML::Node to a yaml string.
 
YAML::Node tesseract::common::fromYAMLString (const std::string &string)
 Converts yaml string to a YAML::Node.
 
bool tesseract::common::compareYAML (const YAML::Node &node1, const YAML::Node &node2)
 Checks if the YAML::Nodes are identical.
 

Detailed Description

YAML Type conversions.

Author
Levi Armstrong
Date
September 5, 2021
License
Software License Agreement (Apache License)
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.