jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation staticRead maximum file size limits (#13485)

Browse source
This commit is contained in:
Juan Carlos 2020-02-26 06:01:23 -03:00 • committed by GitHub
commit 94b0d6bb63
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
lib/system.nim
View file

@ -2525,6 +2525,9 @@ proc staticRead*(filename: string): string {.magic: "Slurp".}
## Compile-time `readFile <io.html#readFile,string>`_ proc for easy ## Compile-time `readFile <io.html#readFile,string>`_ proc for easy
## `resource`:idx: embedding: ## `resource`:idx: embedding:
## ##
## The maximum file size limit that ``staticRead`` and ``slurp`` can read is
## near or equal to the *free* memory of the device you are using to compile.
##
## .. code-block:: Nim ## .. code-block:: Nim
## const myResource = staticRead"mydatafile.bin" ## const myResource = staticRead"mydatafile.bin"
## ##