Semantics of flags on basic_ios

by

There are three flags that indicate error state:

  • badbit means something has gone very wrong with the stream. It might be a buffer error or an error in whatever is feeding data to the stream. If this flag is set, it’s likely that you aren’t going to be using the stream anymore.

  • failbit means that an extraction or a read from the stream failed (or a write or insertion for output streams) and you need to be aware of that failure.

  • eofbit means the input stream has reached its end and there is nothing left to read. Note that this is set only after you attempt to read from an input stream that has reached its end (that is, it is set when an error occurs because you try to read data that isn’t there).

The failbit may also be set by many operations that reach EOF. For example, if there is only whitespace left remaining in the stream and you try to read an int, you will both reach EOF and you will fail to read the int, so both flags will be set.

The fail() function tests badbit || failbit.

The good() function tests !(badbit || failbit || eofbit). That is, a stream is good when none of the bits are set.

You can reset the flags by using the ios::clear() member function; this allows you to set any of the error flags; by default (with no argument), it clears all three flags.

Streams do not overload operator bool(); operator void*() is used to implement a somewhat broken version of the safe bool idiom. This operator overload returns null if badbit or failbit is set, and non-null otherwise. You can use this to support the idiom of testing the success of an extraction as the condition of a loop or other control flow statement:

if (std::cin >> x) {
    // extraction succeeded
}
else {
    // extraction failed
}

The operator!() overload is the opposite of the operator void*(); it returns true if the badbit or failbit is set and false otherwise. The operator!() overload is not really needed anymore; it dates back to before operator overloads were supported completely and consistently (see sbi’s question “Why does std::basic_ios overload the unary logical negation operator?”).

C++0x fixes the problem that causes us to have to use the safe bool idiom, so in C++0x the basic_ios base class template does overload operator bool() as an explicit conversion operator; this operator has the same semantics as the current operator void*().

More Related Contents:

  1. Why does std::getline() skip input after a formatted extraction?
  2. Insertion sort stops working after million input
  3. Why can templates only be implemented in the header file?
  4. When can I use a forward declaration?
  5. “std::endl” vs “\n”
  6. What are all the common undefined behaviours that a C++ programmer should know about? [closed]
  7. What is the difference between public, private, and protected inheritance in C++?
  8. What is the curiously recurring template pattern (CRTP)?
  9. What’s the difference between “STL” and “C++ Standard Library”?
  10. Best practices for circular shift (rotate) operations in C++
  11. How do I remove code duplication between similar const and non-const member functions?
  12. What XML parser should I use in C++? [closed]
  13. Function with same name but different signature in derived class
  14. Why does the use of ‘new’ cause memory leaks?
  15. How can I use cout
  16. Why doesn’t a simple “Hello World”-style program compile with Turbo C++?
  17. What are the new features in C++17?
  18. What is an undefined reference/unresolved external symbol error and how do I fix it?
  19. What does it mean to have an undefined reference to a static member?
  20. What C++ Smart Pointer Implementations are available?
  21. What is the purpose of std::launder?
  22. How to get IOStream to perform better?
  23. Is the ‘override’ keyword just a check for a overridden virtual method?
  24. Why are my struct’s members not properly initialised using `{}`? [duplicate]
  25. gcc/g++: “No such file or directory”
  26. Should I include or in C++ programs?
  27. Why do we actually need Private or Protected inheritance in C++?
  28. What is going on with ‘gets(stdin)’ on the site coderbyte?
  29. What does flushing the buffer mean?
  30. Function with same name but different signature in derived class not found

Leave a Comment