Skip to content

api: Add OIIO_NODISCARD_ERROR to ImageInput open and valid_file methods #5217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PandorasPalette wants to merge 3 commits into
base: main
Choose a base branch
from
+4 −4
Open

api: Add OIIO_NODISCARD_ERROR to ImageInput open and valid_file methods #5217

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6fb90f
Add OIIO_NODISCARD_ERROR to ImageInput::open overloads
PandorasPalette May 27, 2026
977e2f9
Merge branch 'main' of https://github.com/PandorasPalette/OpenImageIO
PandorasPalette May 27, 2026
b2065ca
Add OIIO_NODISCARD to ImageInput::open overloads
PandorasPalette May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/include/OpenImageIO/imageio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -985,12 +985,12 @@ class OIIO_API ImageInput {
/// A `unique_ptr` that will close and free the ImageInput when
/// it exits scope or is reset. The pointer will be empty if the
/// required writer was not able to be created.
static unique_ptr open (const std::string& filename,
OIIO_NODISCARD static unique_ptr open (const std::string& filename,
const ImageSpec *config = nullptr,
Filesystem::IOProxy* ioproxy = nullptr);

/// Create and open an ImageInput using a UTF-16 encoded wstring filename.
static unique_ptr open (const std::wstring& filename,
OIIO_NODISCARD static unique_ptr open (const std::wstring& filename,
const ImageSpec *config = nullptr,
Filesystem::IOProxy* ioproxy = nullptr) {
return open(Strutil::utf16_to_utf8(filename), config, ioproxy);
Expand Down Expand Up @@ -1143,10 +1143,10 @@ class OIIO_API ImageInput {
///
/// @returns
/// `true` upon success, or `false` upon failure.
virtual bool valid_file (const std::string& filename) const;
OIIO_NODISCARD_ERROR virtual bool valid_file (const std::string& filename) const;

/// Check valid file using a UTF-16 encoded wstring filename.
bool valid_file (const std::wstring& filename) const {
OIIO_NODISCARD_ERROR bool valid_file (const std::wstring& filename) const {

@lgritz lgritz Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This, too, should be OIIO_NODISCARD because the result is not an error status, it's just a bool value that tells you whether or not the file is valid.

return valid_file(Strutil::utf16_to_utf8(filename));
}

Expand Down
Loading