AcademySoftwareFoundation / AcademySoftwareFoundation/OpenImageIO

[FEATURE REQUEST] Add [[nodiscard]] to image read/write methods

Open
#4,781 10 comments 0 reactions 0 assignees View on GitHub
core APIs devdays difficulty/easy good first issue help wanted
Dominant language
C++
Stars
2.4k
Forks
698
Avg merge
3d 4h
Merged PRs (30d)
47

Description

This is not so much a feature request but more of an open discussion on whether all of the `read_` and `write_` methods should have a `[[nodiscard]]` attribute added (since C++17) to avoid users not catching whether the read/write was successful or not (caught myself doing this).

This would obviously break ABI and backwards compatibility so I'm happy to hear opinions!

Contributor guide

Open the contributing guide

Research direction

Start by surveying the C++ read_ and write_ methods and checking how their return values are currently used. Confirm the C++17, ABI, and backwards-compatibility implications before defining a consistent scope. Done means a maintainer-approved decision and implementation scope; this issue is currently an open discussion rather than a startable task.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
computer-graphics
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.