Namespaces | Functions
yaml_utils.h File Reference

YAML Type conversions. More...

#include <string>
#include <set>
#include <filesystem>
Include dependency graph for yaml_utils.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 tesseract_common
 
 YAML
 

Functions

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

Detailed Description

YAML Type conversions.

Author
Levi Armstrong
Date
September 5, 2021
Version
TODO
Bug:
No known bugs
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.
Author
Levi Armstrong
Date
September 5, 2021
Version
TODO
Bug:
No known bugs
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.

Definition in file yaml_utils.h.



tesseract_common
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:01:40