Stream utilities

Usage:get_line(S,L)

Reads from Stream a line of text and unifies Line with it. The end of the line can have Unix [10] or Windows/DOS [13, 10] termination, which is not included in Line. At EOF, the term end_of_file is returned.

• The following properties should hold at call time:
  (stream_basic:stream/1)S is an open stream.
• The following properties should hold upon exit:
  (stream_utils:line/1)stream_utils:line(L)

Usage:get_line(L)

Behaves like current_input(S), get_line(S,Line).

• The following properties should hold upon exit:
  (stream_utils:line/1)stream_utils:line(L)

line(L) :-
    string(L).
line(end_of_file).

Usage:read_string_to_end(Stream,String)

Reads in String all the characters from Stream until an EOF is found.

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties should hold upon exit:
  (basic_props:string/1)String is a string (a list of character codes).

Usage:read_bytes_to_end(Stream,Bytes)

Reads in Bytes all the bytes from Stream until an EOF is found.

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
• The following properties should hold upon exit:
  (basic_props:bytelist/1)Bytes is list of bytes.

Usage:discard_to_end(Stream)

Reads in all the bytes from Stream until an EOF is found.

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.

Usage:read_bytes(Stream,N,Bytes)

Reads in Bytes at most N bytes from Stream, or until an EOF is found.

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:int/1)N is an integer.
• The following properties should hold upon exit:
  (basic_props:bytelist/1)Bytes is list of bytes.

Usage:copy_stream(InS,OutS,Copied)

Copies all bytes bytes (until EOF or error) from the InS stream into the OutS stream. The number of copied bytes is returned in Copied

• The following properties should hold at call time:
  (stream_basic:stream/1)InS is an open stream.
  (stream_basic:stream/1)OutS is an open stream.
• The following properties should hold upon exit:
  (basic_props:int/1)Copied is an integer.

Usage:write_string(Stream,String)

Writes String onto Stream.

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:string/1)String is a string (a list of character codes).

Usage:write_string(String)

Behaves like current_input(S), write_string(S, String).

• The following properties should hold at call time:
  (basic_props:string/1)String is a string (a list of character codes).

Usage:write_bytes(Stream,Bytes)

Writes Bytes onto Stream.

• The following properties should hold at call time:
  (stream_basic:stream/1)Stream is an open stream.
  (basic_props:bytelist/1)Bytes is list of bytes.

Usage:write_bytes(Bytes)

Behaves like current_input(S), write_bytes(S, Bytes).

• The following properties should hold at call time:
  (basic_props:bytelist/1)Bytes is list of bytes.

Usage:file_to_string(FileName,String)

Reads all the characters from the file FileName and returns them in String.

• The following properties should hold at call time:
  (stream_basic:sourcename/1)FileName is a source name.
• The following properties should hold upon exit:
  (basic_props:string/1)String is a string (a list of character codes).

Usage:string_to_file(String,FileName)

Reads all the characters from the string String and writes them to file FileName.

• The following properties should hold at call time:
  (basic_props:string/1)String is a string (a list of character codes).
  (stream_basic:sourcename/1)FileName is a source name.

Usage:file_to_bytes(FileName,Bytes)

Reads all the bytes from the file FileName and returns them in Bytes.

• The following properties should hold at call time:
  (stream_basic:sourcename/1)FileName is a source name.
• The following properties should hold upon exit:
  (basic_props:bytelist/1)Bytes is list of bytes.

Usage:bytes_to_file(Bytes,FileName)

Reads all the bytes from the bytes Bytes and writes them to file FileName.

• The following properties should hold at call time:
  (basic_props:bytelist/1)Bytes is list of bytes.
  (stream_basic:sourcename/1)FileName is a source name.

Usage:open_input(FileName,InputStreams)

• The following properties should hold at call time:
  (stream_basic:sourcename/1)FileName is a source name.
• The following properties should hold upon exit:
  (stream_utils:input_handler/1)stream_utils:input_handler(InputStreams)

Usage:close_input(InputStreams)

• The following properties should hold at call time:
  (stream_utils:input_handler/1)stream_utils:input_handler(InputStreams)
• The following properties should hold upon exit:
  (stream_utils:input_handler/1)stream_utils:input_handler(InputStreams)

Usage:open_output(FileName,OutputStreams)

• The following properties should hold at call time:
  (stream_basic:sourcename/1)FileName is a source name.
• The following properties should hold upon exit:
  (stream_utils:output_handler/1)stream_utils:output_handler(OutputStreams)

Usage:close_output(OutputStreams)

• The following properties should hold at call time:
  (stream_utils:output_handler/1)stream_utils:output_handler(OutputStreams)
• The following properties should hold upon exit:
  (stream_utils:output_handler/1)stream_utils:output_handler(OutputStreams)