--- a/FileText.st Sat Apr 27 13:17:40 1996 +0200
+++ b/FileText.st Sat Apr 27 13:21:18 1996 +0200
@@ -35,20 +35,25 @@
documentation
"
- FileText represents the contents of a text-file;
- only the offsets of the text-lines are stored in an internal array
- to save some space. The at: method fetches the line from the file.
- Individual textlines may be replaced by strings.
- the underlying file is NOT updated in this case.
+ FileText represents the contents of a text-file and allows
+ transparent access, via #at:, as if the lineStrings were in
+ memory - although, only a small portion of the file is actually
+ present in a cache.
+
+ Only the offsets of the text-lines are stored in an internal array
+ to save memory space. The #at: method fetches the line from the file.
+ Individual textlines may be replaced by strings (via #at:put:).
+ The underlying file is NOT updated in this case.
Care should be taken, if the underlying file is rewritten -
you have to manually update/flush the pointers.
Never rewrite the file using the data from a FileText.
- If you keep a files contents in a FileText object and want to
+ If you keep a file's contents in a FileText object and want to
rewrite that file, you MUST write to a temporary file first.
Otherwise, you will clobber the contents.
- It is highly recommended, to use fileText for readonly texts only.
+ This is an EXPERIMENTAL class, use at your own risk.
+ (If at all, use fileText for huge readonly texts only.)
[author:]
Claus Gittinger
@@ -186,5 +191,5 @@
!FileText class methodsFor:'documentation'!
version
- ^ '$Header: /cvs/stx/stx/libbasic2/FileText.st,v 1.15 1996-04-25 16:17:14 cg Exp $'
+ ^ '$Header: /cvs/stx/stx/libbasic2/FileText.st,v 1.16 1996-04-27 11:21:18 cg Exp $'
! !