Skip to content

Commit 620d703

Browse files
authored
Merge pull request #374 from sshanks-kx/binary-read
fix file binary read params
2 parents ee69f46 + 1b36c0a commit 620d703

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/ref/file-binary.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@ x 1: y 1:[x;y]
2121
Where
2222
2323
- `x` is a 2-item list (a string of [types](#column-types-and-widths) and an int vector of widths) of which the order determines whether the data is parsed as little-endian or big-endian
24-
- `y` is a [file descriptor](../basics/glossary.md#file-descriptor) or string, or byte sequence
24+
- `y` is either a
25+
- [file descriptor](../basics/glossary.md#file-descriptor) to repeatedly read all available records (specified by `x`) from a file
26+
- 3 element list containing [file descriptor](../basics/glossary.md#file-descriptor), offset (long) and length (long). Enables repeatedly reading all available records (specified by `x`) from a file which stops after the given byte length, starting 'offset' bytes from the start of the file.
27+
- string
28+
- byte sequence
2529

2630
returns the content of `y` as a matrix.
2731

0 commit comments

Comments
 (0)