diff options
Diffstat (limited to 'stdlib/source/documentation/lux/data/binary.lux')
| -rw-r--r-- | stdlib/source/documentation/lux/data/binary.lux | 116 |
1 files changed, 51 insertions, 65 deletions
diff --git a/stdlib/source/documentation/lux/data/binary.lux b/stdlib/source/documentation/lux/data/binary.lux index 475d07a00..80e05d511 100644 --- a/stdlib/source/documentation/lux/data/binary.lux +++ b/stdlib/source/documentation/lux/data/binary.lux @@ -1,7 +1,7 @@ (.require [library [lux (.except) - ["$" documentation (.only documentation:)] + ["$" documentation] [data [text (.only \n) ["%" \\format (.only format)]]] @@ -10,82 +10,68 @@ [\\library ["[0]" /]]) -(documentation: /.Binary - "A binary BLOB of data.") +(.def .public documentation + (.List $.Module) + ($.module /._ + "" + [($.default /.index_out_of_bounds) + ($.default /.slice_out_of_bounds) + ($.default /.size) + ($.default /.equivalence) + ($.default /.monoid) -(documentation: /.empty - "A fresh/empty binary BLOB of the specified size." - [(empty size)]) + ($.documentation /.Binary + "A binary BLOB of data.") -(documentation: /.mix - "" - [(mix f init binary)]) + ($.documentation /.empty + "A fresh/empty binary BLOB of the specified size." + [(empty size)]) -(documentation: /.bits_8 - "Read 1 byte (8 bits) at the given index." - [(bits_8 index binary)]) + ($.documentation /.mix + "" + [(mix f init binary)]) -(documentation: /.bits_16 - "Read 2 bytes (16 bits) at the given index." - [(bits_16 index binary)]) + ($.documentation /.bits_8 + "Read 1 byte (8 bits) at the given index." + [(bits_8 index binary)]) -(documentation: /.bits_32 - "Read 4 bytes (32 bits) at the given index." - [(bits_32 index binary)]) + ($.documentation /.bits_16 + "Read 2 bytes (16 bits) at the given index." + [(bits_16 index binary)]) -(documentation: /.bits_64 - "Read 8 bytes (64 bits) at the given index." - [(bits_64 index binary)]) + ($.documentation /.bits_32 + "Read 4 bytes (32 bits) at the given index." + [(bits_32 index binary)]) -(documentation: /.has_8! - "Write 1 byte (8 bits) at the given index." - [(has_8! index value binary)]) + ($.documentation /.bits_64 + "Read 8 bytes (64 bits) at the given index." + [(bits_64 index binary)]) -(documentation: /.has_16! - "Write 2 bytes (16 bits) at the given index." - [(has_16! index value binary)]) + ($.documentation /.has_8! + "Write 1 byte (8 bits) at the given index." + [(has_8! index value binary)]) -(documentation: /.has_32! - "Write 4 bytes (32 bits) at the given index." - [(has_32! index value binary)]) + ($.documentation /.has_16! + "Write 2 bytes (16 bits) at the given index." + [(has_16! index value binary)]) -(documentation: /.has_64! - "Write 8 bytes (64 bits) at the given index." - [(has_64! index value binary)]) + ($.documentation /.has_32! + "Write 4 bytes (32 bits) at the given index." + [(has_32! index value binary)]) -(documentation: /.copy! - "Mutates the target binary BLOB by copying bytes from the source BLOB to it." - [(copy! bytes source_offset source target_offset target)]) + ($.documentation /.has_64! + "Write 8 bytes (64 bits) at the given index." + [(has_64! index value binary)]) -(documentation: /.slice - "Yields a subset of the binary BLOB, so long as the specified range is valid." - [(slice offset length binary)]) + ($.documentation /.copy! + "Mutates the target binary BLOB by copying bytes from the source BLOB to it." + [(copy! bytes source_offset source target_offset target)]) -(documentation: /.after - "Yields a binary BLOB with at most the specified number of bytes removed." - [(after bytes binary)]) + ($.documentation /.slice + "Yields a subset of the binary BLOB, so long as the specified range is valid." + [(slice offset length binary)]) -(.def .public documentation - (.List $.Module) - ($.module /._ - "" - [..Binary - ..empty - ..mix - ..bits_8 - ..bits_16 - ..bits_32 - ..bits_64 - ..has_8! - ..has_16! - ..has_32! - ..has_64! - ..copy! - ..slice - ..after - ($.default /.index_out_of_bounds) - ($.default /.slice_out_of_bounds) - ($.default /.size) - ($.default /.equivalence) - ($.default /.monoid)] + ($.documentation /.after + "Yields a binary BLOB with at most the specified number of bytes removed." + [(after bytes binary)])] [])) |