Skip to content

[Implement] Buffer#inspect #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jtenner wants to merge 17 commits into
base: main
Choose a base branch
from
Open

[Implement] Buffer#inspect #15

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
99b14a8
[Implement] Buffer#concat (todo: fix tlsf problem)
jtenner Jul 22, 2019
8812172
[Fix] Clean up inspect implementation
jtenner Jul 23, 2019
01d079b
[Fix] Edge case when length = 0, todo: more optimization
jtenner Jul 23, 2019
10a5c54
[Chore] switch to global
jtenner Jul 23, 2019
fe0cf50
[Chore] Merge master
jtenner Jul 23, 2019
f418fd0
[Optimize] memory.copy parameters with global strings
jtenner Jul 23, 2019
cea7473
[Merge] master, use Hex encoding method
jtenner Aug 1, 2019
e5f6e4a
Merge branch 'master' into inspect
jtenner Aug 6, 2019
628562c
[Fix] switch to hex
jtenner Aug 6, 2019
b956d5e
[Fix] types merge problem
jtenner Aug 6, 2019
e8afe85
[fix] example
jtenner Aug 6, 2019
b9ed343
[chore] remove unecessary comment
jtenner Aug 6, 2019
a5579cb
[fix] nit remove parenthesis
jtenner Aug 6, 2019
11cc4d3
[fix] remove type annotation
jtenner Aug 6, 2019
a00145c
[test] use create convenience method instead
jtenner Aug 6, 2019
ef7e34e
[fix] switch to known constant
jtenner Aug 6, 2019
5fe8a7f
[fix] add BUFFER_INSPECT_HEADER_BYTE_LEN constant
jtenner Aug 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[fix] example
  • Loading branch information
@jtenner
jtenner committed Aug 6, 2019
commit e8afe8507aad68355f56608716a2adc2474f7bc8
27 changes: 23 additions & 4 deletions assembly/buffer/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,13 @@ export class Buffer extends Uint8Array {
return offset + 8;
}

/**
* Calculate an inspectable string to print to the console.
*
* @example
* let result = Buffer.from([1, 2, 3, 4, 5]).inspect();
* // '<Buffer 01 02 03 04 05>'
*/
inspect(): string {
let byteLength = this.byteLength;
if (INSPECT_MAX_BYTES == 0 || byteLength == 0) return "<Buffer >";
Expand All @@ -252,10 +259,22 @@ export class Buffer extends Uint8Array {
// find the start of the buffer
let dataStart = this.dataStart;

// formula for calculating end string length (3 * bytes) + 8
// Example: Buffer.from([1, 2, 3, 4, 5]).inspect() == '<Buffer 01 02 03 04 05>'
let stringLength = 3 * maxBytes + 8;
if (elipsisEnd) stringLength += 3; // add 3 characters for elipsis
/**
* Formula for stringLength is calculated by adding the constant character count
* to the number of visible bytes multiplied by 3, and adding 3 more for an ellipsis
* if the total number of visible bytes is less than the actual byteLength.
*
* @example
* let stringLength = (3 * maxBytes) + len("<Buffer ") + len(">") + (elipsisEnd ? 3 : 0);
*
* // This can be reduced to...
* let stringLength = (3 * maxBytes) + 8 + (elipsisEnd ? 3 : 0);
*
* // finally, `a * 3 + 3` is the same thing as `(a + 1) * 3`
* // we can cast `elipsisEnd` to an integer `1 | 0`
* let stringLength = 3 * (maxBytes + i32(elipsisEnd)) + 8;
*/
let stringLength = 3 * (maxBytes + i32(elipsisEnd)) + 8; // add 3 characters for elipsis

// create the result
let result = __alloc(stringLength << 1, idof<String>());
Expand Down