chore: Attribute::get_enumeration_name
returns a reference rather than a copy in order to add Rust binding
#5567
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is split off of #5566 in order to keep that pull request more focused.
Differences in copy and move semantics between Rust and C++ mean that they are generally not very good at passing values across the boundary - most of the time it is necessary to pass references instead.
#5566 intends to call
Attribute::get_enumeration_name
from Rust. Prior to these changes, that function returnsstd::optional<std::string>
, which cannot be passed across the boundary (neitherstd::optional
norstd::string
can be). We can either pass a pointer to a string, or pass a string contained within a smart pointer.To avoid the additional memory allocations required for both copying the
std::string
and placing it in aunique_ptr
, we choose the former.However,
std::optional
does not naturally support references, so we cannot dostd::optional<std::string&>
. Instead we change the return type tostd::optional<std::reference_wrapper<std::string>>
.In addition to enabling passing the result of this function to Rust without allocating additional memory, this also avoids making additional copies of the string. This is not likely to matter from a performance perspective, but is still nice!
TYPE: NO_HISTORY
DESC: Rust binding for
Attribute::get_enumeration_name