Class Bytes<T>

A convenience wrapper for a fix-length sequence of bytes.

Type Parameters

T extends number

Hierarchy (View Summary)

BytesBlob
- Bytes

Properties

`Readonly`length

length: T

Length of the bytes array.

`Readonly`raw

raw: Uint8Array

Methods

[TEST_COMPARE_USING]

"[TEST_COMPARE_USING]"(): string
Returns string
Inherited from BytesBlob.[TEST_COMPARE_USING]
- Defined in packages/core/bytes/bytes.ts:19

asOpaque

asOpaque<R>(): pvm.Opaque<Bytes<T>, pvm.TokenOf<R, Bytes<T>>>
Converts current type into some opaque extension.
Type Parameters
- R
Returns pvm.Opaque<Bytes<T>, pvm.TokenOf<R, Bytes<T>>>
- Defined in packages/core/bytes/bytes.ts:240

asText

asText(): string
Decode contained bytes as string.

Returns string
Inherited from BytesBlob.asText
- Defined in packages/core/bytes/bytes.ts:54

chunks

chunks(size: number): Generator<BytesBlob>
Split BytesBlob into chunks of given size.

Last chunk might be smaller than size.
Parameters
- size: number
Returns Generator<BytesBlob>
Inherited from BytesBlob.chunks
- Defined in packages/core/bytes/bytes.ts:167

compare

compare(other: BytesBlob): Ordering
Compare the sequence to another one lexicographically. Returns Ordering.Less if "this" blob is less than (or shorter than) "other", Ordering.Equal if blobs are identical and Ordering.Greater otherwise. https://graypaper.fluffylabs.dev/#/5f542d7/07c40007c400
Parameters
- other: BytesBlob
Returns Ordering
Inherited from BytesBlob.compare
- Defined in packages/core/bytes/bytes.ts:72

isEqualTo

isEqualTo(other: Bytes<T>): boolean
Compare the sequence to another one.
Parameters
- other: Bytes<T>
Returns boolean
Overrides BytesBlob.isEqualTo
- Defined in packages/core/bytes/bytes.ts:234

toJSON

toJSON(): string
Returns string
Inherited from BytesBlob.toJSON
- Defined in packages/core/bytes/bytes.ts:49

toString

toString(): string
Display a hex-encoded version of this byte blob.

Returns string
Inherited from BytesBlob.toString
- Defined in packages/core/bytes/bytes.ts:34

toStringTruncated

toStringTruncated(): string
Display a hex-encoded version of this byte blob, but truncated if it's large.

Returns string
Inherited from BytesBlob.toStringTruncated
- Defined in packages/core/bytes/bytes.ts:39

`Static`blobFrom

blobFrom(v: Uint8Array): BytesBlob
Create a new [BytesBlob] from existing [Uint8Array].
Parameters
- v: Uint8Array
Returns BytesBlob
Inherited from BytesBlob.blobFrom
- Defined in packages/core/bytes/bytes.ts:110

`Static`blobFromNumbers

blobFromNumbers(v: number[]): BytesBlob
Create a new [BytesBlob] from an array of bytes.
Parameters
- v: number[]
Returns BytesBlob
Inherited from BytesBlob.blobFromNumbers
- Defined in packages/core/bytes/bytes.ts:132

`Static`blobFromParts

blobFromParts(
v: Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[],
...rest: Uint8Array<ArrayBufferLike>[],
): BytesBlob
Create a new [BytesBlob] by concatenating data from multiple Uint8Arrays.
Parameters
- v: Uint8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>[]
- ...rest: Uint8Array<ArrayBufferLike>[]
Returns BytesBlob
Inherited from BytesBlob.blobFromParts
- Defined in packages/core/bytes/bytes.ts:115

`Static`blobFromString

blobFromString(v: string): BytesBlob
Create a new [`BytesBlob'] by converting given UTF-u encoded string into bytes.
Parameters
- v: string
Returns BytesBlob
Inherited from BytesBlob.blobFromString
- Defined in packages/core/bytes/bytes.ts:104

`Static`empty

empty(): BytesBlob
Create a new [BytesBlob] with no data.

Returns BytesBlob
Inherited from BytesBlob.empty
- Defined in packages/core/bytes/bytes.ts:99

`Static`fill

fill<X extends number>(len: X, input: number): Bytes<X>
Create a [Bytes<X>] with all bytes filled with given input number.
Type Parameters
- X extends number
Parameters
- len: X
- input: number
Returns Bytes<X>
- Defined in packages/core/bytes/bytes.ts:206

`Static`fromBlob

fromBlob<X extends number>(v: Uint8Array, len: X): Bytes<X>
Create new [Bytes<X>] given a backing buffer and it's length.
Type Parameters
- X extends number
Parameters
- v: Uint8Array
- len: X
Returns Bytes<X>
- Defined in packages/core/bytes/bytes.ts:188

`Static`fromNumbers

fromNumbers<X extends number>(v: number[], len: X): Bytes<X>
Create new [Bytes<X>] given an array of bytes and it's length.
Type Parameters
- X extends number
Parameters
- v: number[]
- len: X
Returns Bytes<X>
- Defined in packages/core/bytes/bytes.ts:193

`Static`parseBlob

parseBlob(v: string): BytesBlob
Parse a hex-encoded bytes blob with 0x prefix.
Parameters
- v: string
Returns BytesBlob
Inherited from BytesBlob.parseBlob
- Defined in packages/core/bytes/bytes.ts:155

`Static`parseBlobNoPrefix

parseBlobNoPrefix(v: string): BytesBlob
Parse a hex-encoded bytes blob without 0x prefix.
Parameters
- v: string
Returns BytesBlob
Inherited from BytesBlob.parseBlobNoPrefix
- Defined in packages/core/bytes/bytes.ts:139

`Static`parseBytes

parseBytes<X extends number>(v: string, len: X): Bytes<X>
Parse a hex-encoded fixed-length bytes with 0x prefix.
Type Parameters
- X extends number
Parameters
- v: string
- len: X
Returns Bytes<X>
- Defined in packages/core/bytes/bytes.ts:224

`Static`parseBytesNoPrefix

parseBytesNoPrefix<X extends number>(v: string, len: X): Bytes<X>
Parse a hex-encoded fixed-length bytes without 0x prefix.
Type Parameters
- X extends number
Parameters
- v: string
- len: X
Returns Bytes<X>
- Defined in packages/core/bytes/bytes.ts:214

`Static`zero

zero<X extends number>(len: X): Bytes<X>
Create an empty [Bytes<X>] of given length.
Type Parameters
- X extends number
Parameters
- len: X
Returns Bytes<X>
- Defined in packages/core/bytes/bytes.ts:200