api/nmbs_8h_source.html

#pragma once


#include <string>

#include <filesystem>


#include "binding.h"

#include "confidentiality_label.h"

#include "binding_information.h"

#include "expected.h"


namespace nmbs

{

    [[nodiscard]] std::string_view version() noexcept;


    void cleanup();


    [[nodiscard]] Expected<std::string> write_labels(

        const std::filesystem::path& path,

        const std::vector<ConfidentialityLabel>& confidentiality_labels,

        std::optional<binding::ProfileSupport> binding_support = std::nullopt);


    [[nodiscard]] Expected<std::optional<binding::BindingInformation>> read_binding(

        const std::filesystem::path& path,

        std::optional<binding::ProfileSupport> binding_support = std::nullopt);


    [[nodiscard]] Expected<std::optional<std::string>> read_binding_xml(

        const std::filesystem::path& path,

        std::optional<binding::ProfileSupport> binding_support = std::nullopt);


    Expected<void> remove_binding(

        const std::filesystem::path& path,

        std::optional<binding::ProfileSupport> binding_support = std::nullopt);

}

binding.h
Core binding profile support flags and analysis functions.

binding_information.h
Object representation of the ADatP-4778 BindingInformation element.

confidentiality_label.h
Object representation of a Confidentiality Label as per ADatP-4774.

expected.h
Standard error handling types for the nmbs library.

nmbs::binding
Functionality for the numerous binding profiles of ADatP-4778.
Definition binding.h:38

nmbs
Lightweight utilities for NATO confidentiality metadata.
Definition binding.h:38

nmbs::Expected
std::expected< T, Error > Expected
Alias for std::expected standardized with nmbs::Error.
Definition expected.h:156

nmbs::cleanup
void cleanup()
Releases globally allocated memory and resets library state.

nmbs::read_binding
Expected< std::optional< binding::BindingInformation > > read_binding(const std::filesystem::path &path, std::optional< binding::ProfileSupport > binding_support=std::nullopt)
Reads and deserializes the ADatP-4778 binding from the specified file.

nmbs::read_binding_xml
Expected< std::optional< std::string > > read_binding_xml(const std::filesystem::path &path, std::optional< binding::ProfileSupport > binding_support=std::nullopt)
Reads the raw XML of the ADatP-4778 binding from the specified file.

nmbs::remove_binding
Expected< void > remove_binding(const std::filesystem::path &path, std::optional< binding::ProfileSupport > binding_support=std::nullopt)
Removes the ADatP-4778 binding from the specified file.

nmbs::write_labels
Expected< std::string > write_labels(const std::filesystem::path &path, const std::vector< ConfidentialityLabel > &confidentiality_labels, std::optional< binding::ProfileSupport > binding_support=std::nullopt)
Writes ADatP-4778 binding information using the optimal binding profile.

nmbs::version
std::string_view version() noexcept
Retrieves the semantic version of the library.

nmbs::ConfidentialityLabel
Struct representation of the ADatP-4774 "Confidentiality Label".
Definition confidentiality_label.h:46