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

Spruce up doc comments as per dom96 suggestions.

Browse source
This commit is contained in:
Charles Blake 2015-08-03 12:34:03 -04:00
commit 9e8b4475e2
1 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

19
lib/pure/memfiles.nim
View file

@ -263,12 +263,12 @@ proc `$`*(ms: MemSlice): string {.inline.} =
iterator memSlices*(mfile: MemFile, delim='\l', eat='\r'): MemSlice {.inline.} = iterator memSlices*(mfile: MemFile, delim='\l', eat='\r'): MemSlice {.inline.} =
## Iterates over [optional eat]delim-delimited slices in a MemFile. ## Iterates over [optional eat]delim-delimited slices in a MemFile.
## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines. ## Default delimiting is [\\r]\\l which parses Unix/Windows text file lines.
## Pass eat='\\0' to be strictly delim-delimited. ## Pass eat='\\0' to be strictly delim-delimited.
## This zero copy, memchr-limited method is probably the fastest way to ## This zero copy, memchr-limited method is probably the fastest way to
## iterate through lines in a file, however the returned (data,size) objects ## iterate through lines in a file. The returned (data,size) objects are
## are NOT Nim strings or even terminated C strings. So, be careful how data ## NOT Nim strings or even terminated C strings. So, be careful how data
## is accessed (e.g., use C mem* functions, not str* functions). Example: ## is accessed (e.g., think C mem* functions, not str* functions). Example:
## ##
## .. code-block:: nim ## .. code-block:: nim
## var count = 0 ## var count = 0
@ -298,8 +298,13 @@ iterator memSlices*(mfile: MemFile, delim='\l', eat='\r'): MemSlice {.inline.} =
iterator lines*(mfile: MemFile, buf: var TaintedString, delim='\l', eat='\r'): TaintedString {.inline.} = iterator lines*(mfile: MemFile, buf: var TaintedString, delim='\l', eat='\r'): TaintedString {.inline.} =
## Replace contents of passed buffer with each new line, like readLine(File). ## Replace contents of passed buffer with each new line, like readLine(File).
## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines. ## Default delimiting is [\\r]\\l which parses Unix/Windows text file lines.
## Pass eat='\\0' to be strictly delim-delimited. ## Pass eat='\\0' to be strictly delim-delimited. Example:
##
## .. code-block:: nim
## var buffer: TaintedString = ""
## for line in lines(memfiles.open("foo"), buffer):
## echo line
for ms in memSlices(mfile, delim, eat): for ms in memSlices(mfile, delim, eat):
buf.setLen(ms.size) buf.setLen(ms.size)
c_memcpy(addr(buf[0]), ms.data, ms.size) c_memcpy(addr(buf[0]), ms.data, ms.size)
@ -308,7 +313,7 @@ iterator lines*(mfile: MemFile, buf: var TaintedString, delim='\l', eat='\r'): T
iterator lines*(mfile: MemFile, delim='\l', eat='\r'): TaintedString {.inline.} = iterator lines*(mfile: MemFile, delim='\l', eat='\r'): TaintedString {.inline.} =
## Return each line in a file as a Nim string, like lines(File). ## Return each line in a file as a Nim string, like lines(File).
## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines. ## Default delimiting is [\\r]\\l which parses Unix/Windows text file lines.
## Pass eat='\0' to be strictly delim-delimited. Example: ## Pass eat='\0' to be strictly delim-delimited. Example:
## ##
## .. code-block:: nim ## .. code-block:: nim