holoscan::params::ParamRebindError | Holoscan SDK Documentation

Own one typed snapshot-to-Graph conversion failure.

The value owns bounded path and schema context plus structured tooling detail. Context that exceeds a declared capacity is truncated and reported by context_truncated(). The object is safe to read concurrently while no thread mutates or destroys it.

#include <holoscan/params/rebind.hpp>

Constructors

ParamRebindError

holoscan::params::ParamRebindError::ParamRebindError(
    ParamRebindErrorCode code,
    ParamRebindStage stage,
    ParamToolError detail,
    std::string_view source_path = {},
    std::string_view target_path = {},
    std::string_view source_schema_id = {},
    std::string_view target_schema_id = {},
    ParamFieldId source_field = {},
    ParamFieldId target_field = {},
    std::optional<ParamSchemaHash> migration_evidence = std::nullopt
) noexcept

Construct one bounded rebinding failure.

Construction is non-throwing; oversized textual context is truncated.

Parameters

code

ParamRebindErrorCode

Stable failure category.

stage

ParamRebindStage

Exact cold-path stage that rejected the operation.

detail

ParamToolError

Owning tooling failure detail and optional nested cause.

source_path

std::string_viewDefaults to {}

Source Operator or field path, when known.

target_path

std::string_viewDefaults to {}

Target Operator or field path, when known.

source_schema_id

std::string_viewDefaults to {}

Source schema identity, when known.

target_schema_id

std::string_viewDefaults to {}

Target schema identity, when known.

source_field

ParamFieldIdDefaults to {}

Source field identity, or zero when unavailable.

target_field

ParamFieldIdDefaults to {}

Target field identity, or zero when unavailable.

migration_evidence

std::optional<ParamSchemaHash>Defaults to std::nullopt

Qualified migration evidence ID, when applicable.

Methods

code

ParamRebindErrorCode holoscan::params::ParamRebindError::code() const noexcept

Return the stable failure category.

stage

ParamRebindStage holoscan::params::ParamRebindError::stage() const noexcept

Return the exact stage that rejected the operation.

source_path

std::string_view holoscan::params::ParamRebindError::source_path() const noexcept

Return the retained source path.

The view remains valid until this error is assigned or destroyed.

target_path

std::string_view holoscan::params::ParamRebindError::target_path() const noexcept

Return the retained target path.

The view remains valid until this error is assigned or destroyed.

source_schema_id

std::string_view holoscan::params::ParamRebindError::source_schema_id() const noexcept

Return the retained source schema ID.

The view remains valid until this error is assigned or destroyed.

target_schema_id

std::string_view holoscan::params::ParamRebindError::target_schema_id() const noexcept

Return the retained target schema ID.

The view remains valid until this error is assigned or destroyed.

source_field

ParamFieldId holoscan::params::ParamRebindError::source_field() const noexcept

Return the source field ID, or zero when unavailable.

target_field

ParamFieldId holoscan::params::ParamRebindError::target_field() const noexcept

Return the target field ID, or zero when unavailable.

migration_evidence

const std::optional<ParamSchemaHash> & holoscan::params::ParamRebindError::migration_evidence() const noexcept

Return qualified migration evidence associated with the failure.

Returns: Evidence hash, or empty when migration was not involved.

context_truncated

bool holoscan::params::ParamRebindError::context_truncated() const noexcept

Return whether any textual diagnostic context was truncated.

detail

const ParamToolError & holoscan::params::ParamRebindError::detail() const noexcept

Return structured tooling detail retained by this error.

The reference remains valid until this error is assigned or destroyed.

Member variables

Name	Type	Description
`kPathCapacity` static constexpr	`std::size_t`	Maximum bytes per retained path.
`kSchemaIdCapacity` static constexpr	`std::size_t`	Maximum bytes per schema ID.
`code_`	`ParamRebindErrorCode`
`stage_`	`ParamRebindStage`
`source_path_`	`std::array< char, kPathCapacity >`
`target_path_`	`std::array< char, kPathCapacity >`
`source_schema_id_`	`std::array< char, kSchemaIdCapacity >`
`target_schema_id_`	`std::array< char, kSchemaIdCapacity >`
`source_path_size_`	`std::uint16_t`
`target_path_size_`	`std::uint16_t`
`source_schema_id_size_`	`std::uint16_t`
`target_schema_id_size_`	`std::uint16_t`
`source_field_`	`ParamFieldId`
`target_field_`	`ParamFieldId`
`migration_evidence_`	`std::optional< ParamSchemaHash >`
`context_truncated_`	`bool`
`detail_`	`ParamToolError`