This predicate tests whether the specified open input stream has stream position end-of-stream or past-end-of-stream. If the iput stream has properties end_of_stream(at) or end_of_stream(past) then this predicate succeeds with empty local substitution else it fails.
see also: at_end_of_stream/0 close/1 close/2 close_user_streams/0 current_input/1 current_output/1 flush_output/0 flush_output/1 open/3 open/4 prolog I/O set_input/1 set_output/1 set_stream_position/2 set_stream_property/2 stream_property/2
| Example | |
| at_end_of_stream(user_input). | fails if there is still input to be scanned on the stream named 'user_input' |
| Exceptions | |
| stream_or_alias is a variable | an instantiation_error exception is thrown |
| stream_or_alias is neither a variable nor a stream term nor an alias | a domain_error(stream_or_alias, Stream) exception is thrown, the variable Stream is assigned the incorrect stream_or_alias term |
| stream_or_alias is not associated with an open stream | an existence_error(stream, Stream) exception is thrown |