holoscan::config::ConfigCodec< std::string >

Beta

Provide the built-in owning UTF-8 string codec.

#include <holoscan/config/codec.hpp>

Static methods

decode

static ConfigResult<std::string> holoscan::config::ConfigCodec<std::string>::decode(
    ConfigView view,
    const DecodeOptions &,
    DecodeContext &context
)

Decode and copy a UTF-8 string under the monotonic allocation budget.

Returns: The owning string or a structured type/budget/allocation failure.

Parameters

view

ConfigView

Semantic string to inspect.

context

DecodeContext &

Borrowed monotonic decode context.

encode

static ConfigResult<ConfigValue> holoscan::config::ConfigCodec<std::string>::encode(
    const std::string &value,
    const EncodeOptions &,
    EncodeContext &context
)

Encode and copy an owning UTF-8 string under the monotonic allocation budget.

Returns: The immutable string value or a structured UTF-8/budget/allocation failure.

Parameters

value

const std::string &

UTF-8 string to encode.

context

EncodeContext &

Borrowed monotonic encode context.