holoscan::config::ConfigErrorCause

Beta

Borrow one bounded entry from a configuration error’s nested-cause chain.

Instances are stored inside ConfigError. Returned text/excerpt views remain valid only while the owning ConfigError is alive and unmodified. Inspection is allocation-free and thread-safe for concurrent readers of the same immutable error.

#include <holoscan/config/document.hpp>

Methods

code

ConfigErrorCode holoscan::config::ConfigErrorCause::code() const noexcept

Return the stable machine-readable failure category.

token

std::string_view holoscan::config::ConfigErrorCause::token() const noexcept

Return the stable token corresponding to code.

message

std::string_view holoscan::config::ConfigErrorCause::message() const noexcept

Return the copied message bytes.

path

std::string_view holoscan::config::ConfigErrorCause::path() const noexcept

Return the copied rendered path bytes.

source

std::string_view holoscan::config::ConfigErrorCause::source() const noexcept

Return the copied source-name bytes.

excerpt

std::span<const std::byte> holoscan::config::ConfigErrorCause::excerpt() const noexcept

Return the copied raw excerpt bytes.

message_truncated

bool holoscan::config::ConfigErrorCause::message_truncated() const noexcept

Return whether message text was truncated.

path_truncated

bool holoscan::config::ConfigErrorCause::path_truncated() const noexcept

Return whether rendered path text was truncated.

source_truncated

bool holoscan::config::ConfigErrorCause::source_truncated() const noexcept

Return whether source-name text was truncated.

excerpt_truncated

bool holoscan::config::ConfigErrorCause::excerpt_truncated() const noexcept

Return whether excerpt bytes were truncated.

cause_overflow

bool holoscan::config::ConfigErrorCause::cause_overflow() const noexcept

Return whether deeper causes were discarded after this entry.

operation_stage

ConfigOperationStage holoscan::config::ConfigErrorCause::operation_stage() const noexcept

Return the operation stage associated with this cause.

destination_state

ConfigDestinationState holoscan::config::ConfigErrorCause::destination_state() const noexcept

Return the destination state associated with this cause.

Member variables

Name	Type	Description
`kMessageStorageBytes` static constexpr	`std::size_t`
`kPathStorageBytes` static constexpr	`std::size_t`
`kSourceStorageBytes` static constexpr	`std::size_t`
`kExcerptStorageBytes` static constexpr	`std::size_t`
`code_`	`ConfigErrorCode`
`stage_`	`ConfigOperationStage`
`destination_`	`ConfigDestinationState`
`message_`	`std::array< char, kMessageStorageBytes >`
`path_`	`std::array< char, kPathStorageBytes >`
`source_`	`std::array< char, kSourceStorageBytes >`
`excerpt_`	`std::array< std::byte, kExcerptStorageBytes >`
`message_size_`	`std::uint16_t`
`path_size_`	`std::uint16_t`
`source_size_`	`std::uint16_t`
`excerpt_size_`	`std::uint16_t`
`message_truncated_`	`bool`
`path_truncated_`	`bool`
`source_truncated_`	`bool`
`excerpt_truncated_`	`bool`
`cause_overflow_`	`bool`