aboutsummaryrefslogtreecommitdiffstats
path: root/src/bitfield/8byte.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/bitfield/8byte.h')
-rw-r--r--src/bitfield/8byte.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/bitfield/8byte.h b/src/bitfield/8byte.h
index 9cbf61a9..36b5fe60 100644
--- a/src/bitfield/8byte.h
+++ b/src/bitfield/8byte.h
@@ -55,8 +55,11 @@ uint64_t get_bit_field(uint64_t source, const uint16_t offset,
* value - the value to set in the bit field.
* offset - the starting index of the bit field (beginning from 0).
* bit_count - the number of bits to set in the data.
+ *
+ * Returns true if the bit_count is enough to fully represent the value, and
+ * false if it will not fit.
*/
-void set_bit_field(uint64_t* destination, uint64_t value, const uint16_t offset,
+bool set_bit_field(uint64_t* destination, uint64_t value, const uint16_t offset,
const uint16_t bit_count);
/* Public: Retreive the nth byte out of 8 bytes in a uint64_t.