File: string_of_file.doc

package info (click to toggle)
hol-light 20230128-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 45,636 kB
  • sloc: ml: 688,681; cpp: 439; makefile: 302; lisp: 286; java: 279; sh: 251; yacc: 108; perl: 78; ansic: 57; sed: 39; python: 13
file content (32 lines) | stat: -rw-r--r-- 655 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
\DOC string_of_file

\TYPE {string_of_file : string -> string}

\SYNOPSIS
Read file and convert content into a string.

\DESCRIBE
When given a filename, the function {strings_of_file} attempts to open the file
for input, and if this is successful reads and closes it, returning the
contents as a single string.

\FAILURE
Fails if the file cannot be opened (e.g. it does not exist, or the permissions
are wrong).

\EXAMPLE
If the file {/tmp/greeting} contains the text
{
Hello world
Goodbye world
}
\noindent then
{
  # string_of_file "/tmp/greeting";;
  val it : string = "Hello world\nGoodbye world"
}

\SEEALSO
file_of_string, strings_of_file.

\ENDDOC