Module `sui::bcs`

This module implements BCS (de)serialization in Move. Full specification can be found here: https://github.com/diem/bcs

Short summary (for Move-supported types):

address - sequence of X bytes
bool - byte with 0 or 1
u8 - a single u8 byte
u16 / u32 / u64 / u128 / u256 - LE bytes
vector - ULEB128 length + LEN elements
option - first byte bool: None (0) or Some (1), then value

Usage example:

/// This function reads u8 and u64 value from the input
/// and returns the rest of the bytes.
fun deserialize(bytes: vector<u8>): (u8, u64, vector<u8>) {
use sui::bcs::{Self, BCS};

let prepared: BCS = bcs::new(bytes);
let (u8_value, u64_value) = (
prepared.peel_u8(),
prepared.peel_u64()
);

// unpack bcs struct
let leftovers = prepared.into_remainder_bytes();

(u8_value, u64_value, leftovers)
}

Struct BCS
Constants
Function to_bytes
Function new
Function into_remainder_bytes
Function peel_address
Function peel_bool
Function peel_u8
Macro function peel_num
Function peel_u16
Function peel_u32
Function peel_u64
Function peel_u128
Function peel_u256
Function peel_vec_length
Macro function peel_vec
Function peel_vec_address
Function peel_vec_bool
Function peel_vec_u8
Function peel_vec_vec_u8
Function peel_vec_u16
Function peel_vec_u32
Function peel_vec_u64
Function peel_vec_u128
Function peel_vec_u256
Function peel_enum_tag
Macro function peel_option
Function peel_option_address
Function peel_option_bool
Function peel_option_u8
Function peel_option_u16
Function peel_option_u32
Function peel_option_u64
Function peel_option_u128
Function peel_option_u256

<pre><code>use <a href="../std/ascii.md#std_ascii">std::ascii</a>; use <a href="../std/bcs.md#std_bcs">std::bcs</a>; use <a href="../std/option.md#std_option">std::option</a>; use <a href="../std/string.md#std_string">std::string</a>; use <a href="../std/vector.md#std_vector">std::vector</a>; use <a href="../sui/address.md#sui_address">sui::address</a>; use <a href="../sui/hex.md#sui_hex">sui::hex</a>; </code></pre>

Struct `BCS`

A helper struct that saves resources on operations. For better vector performance, it stores reversed bytes of the BCS and enables use of <code>vector::pop_back</code>.

<pre><code>public struct <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>bytes: vector<u8></code> </dt> <dd> </dd> </dl> </details>

Constants

For when bytes length is less than required for deserialization.

<pre><code>const <a href="../sui/bcs.md#sui_bcs_EOutOfRange">EOutOfRange</a>: u64 = 0; </code></pre>

For when the boolean value different than <code>0</code> or <code>1</code>.

<pre><code>const <a href="../sui/bcs.md#sui_bcs_ENotBool">ENotBool</a>: u64 = 1; </code></pre>

For when ULEB byte is out of range (or not found).

<pre><code>const <a href="../sui/bcs.md#sui_bcs_ELenOutOfRange">ELenOutOfRange</a>: u64 = 2; </code></pre>

Function `to_bytes`

Get BCS serialized bytes for any value. Re-exports stdlib <code><a href="../sui/bcs.md#sui_bcs_to_bytes">bcs::to_bytes</a></code>.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_to_bytes">to_bytes</a><T>(value: &T): vector<u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_to_bytes">to_bytes</a><T>(value: &T): vector<u8> { <a href="../sui/bcs.md#sui_bcs_to_bytes">bcs::to_bytes</a>(value) } </code></pre> </details>

Function `new`

Creates a new instance of BCS wrapper that holds inversed bytes for better performance.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_new">new</a>(bytes: vector<u8>): <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_new">new</a>(mut bytes: vector<u8>): <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a> { bytes.reverse(); <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a> { bytes } } </code></pre> </details>

Function `into_remainder_bytes`

Unpack the <code><a href="../sui/bcs.md#sui_bcs_BCS">BCS</a></code> struct returning the leftover bytes. Useful for passing the data further after partial deserialization.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_into_remainder_bytes">into_remainder_bytes</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_into_remainder_bytes">into_remainder_bytes</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<u8> { let <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a> { mut bytes } = <a href="../sui/bcs.md#sui_bcs">bcs</a>; bytes.reverse(); bytes } </code></pre> </details>

Function `peel_address`

Read address from the bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_address">peel_address</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_address">peel_address</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): address { assert!(<a href="../sui/bcs.md#sui_bcs">bcs</a>.bytes.length() >= <a href="../sui/address.md#sui_address_length">address::length</a>(), <a href="../sui/bcs.md#sui_bcs_EOutOfRange">EOutOfRange</a>); <a href="../sui/address.md#sui_address_from_bytes">address::from_bytes</a>(vector::tabulate!(<a href="../sui/address.md#sui_address_length">address::length</a>(), |_| <a href="../sui/bcs.md#sui_bcs">bcs</a>.bytes.pop_back())) } </code></pre> </details>

Function `peel_bool`

Read a <code>bool</code> value from bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_bool">peel_bool</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_bool">peel_bool</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): bool { let value = <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u8">peel_u8</a>(); if (value == 0) false else if (value == 1) true else abort <a href="../sui/bcs.md#sui_bcs_ENotBool">ENotBool</a> } </code></pre> </details>

Function `peel_u8`

Read <code>u8</code> value from bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u8">peel_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u8 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u8">peel_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u8 { assert!(<a href="../sui/bcs.md#sui_bcs">bcs</a>.bytes.length() >= 1, <a href="../sui/bcs.md#sui_bcs_EOutOfRange">EOutOfRange</a>); <a href="../sui/bcs.md#sui_bcs">bcs</a>.bytes.pop_back() } </code></pre> </details>

Macro function `peel_num`

<pre><code>macro fun <a href="../sui/bcs.md#sui_bcs_peel_num">peel_num</a><$I, $T>($<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>, $len: u64, $bits: $I): $T </code></pre> <details> <summary>Implementation</summary> <pre><code>macro fun <a href="../sui/bcs.md#sui_bcs_peel_num">peel_num</a><$I, $T>($<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>, $len: u64, $bits: $I): $T { let <a href="../sui/bcs.md#sui_bcs">bcs</a> = $<a href="../sui/bcs.md#sui_bcs">bcs</a>; assert!(<a href="../sui/bcs.md#sui_bcs">bcs</a>.bytes.length() >= $len, <a href="../sui/bcs.md#sui_bcs_EOutOfRange">EOutOfRange</a>); let mut value: $T = 0; let mut i: $I = 0; let bits = $bits; while (i < bits) { let byte = <a href="../sui/bcs.md#sui_bcs">bcs</a>.bytes.pop_back() as $T; value = value + (byte << (i as u8)); i = i + 8; }; value } </code></pre> </details>

Function `peel_u16`

Read <code>u16</code> value from bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u16">peel_u16</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u16 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u16">peel_u16</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u16 { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_num">peel_num</a>!(2, 16u8) } </code></pre> </details>

Function `peel_u32`

Read <code>u32</code> value from bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u32">peel_u32</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u32 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u32">peel_u32</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u32 { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_num">peel_num</a>!(4, 32u8) } </code></pre> </details>

Function `peel_u64`

Read <code>u64</code> value from bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u64">peel_u64</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u64">peel_u64</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u64 { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_num">peel_num</a>!(8, 64u8) } </code></pre> </details>

Function `peel_u128`

Read <code>u128</code> value from bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u128">peel_u128</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u128 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u128">peel_u128</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u128 { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_num">peel_num</a>!(16, 128u8) } </code></pre> </details>

Function `peel_u256`

Read <code>u256</code> value from bcs-serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u256">peel_u256</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u256 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_u256">peel_u256</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u256 { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_num">peel_num</a>!(32, 256u16) } </code></pre> </details>

Function `peel_vec_length`

Read ULEB bytes expecting a vector length. Result should then be used to perform <code>peel_*</code> operation LEN times.

In BCS <code>vector</code> length is implemented with ULEB128; See more here: https://en.wikipedia.org/wiki/LEB128

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_length">peel_vec_length</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_length">peel_vec_length</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u64 { let (mut total, mut shift, mut len) = (0u64, 0u8, 0u64); loop { assert!(len <= 4, <a href="../sui/bcs.md#sui_bcs_ELenOutOfRange">ELenOutOfRange</a>); let byte = <a href="../sui/bcs.md#sui_bcs">bcs</a>.bytes.pop_back() as u64; len = len + 1; total = total | ((byte & 0x7f) << shift); if ((byte & 0x80) == 0) break; shift = shift + 7; }; total } </code></pre> </details>

Macro function `peel_vec`

Peel <code>vector<$T></code> from serialized bytes, where <code>$peel: |&mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>| -> $T</code> gives the functionality of peeling each value.

<pre><code>public macro fun <a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a><$T>($<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>, $peel: |&mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>| -> $T): vector<$T> </code></pre> <details> <summary>Implementation</summary> <pre><code>public macro fun <a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a><$T>($<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>, $peel: |&mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>| -> $T): vector<$T> { let <a href="../sui/bcs.md#sui_bcs">bcs</a> = $<a href="../sui/bcs.md#sui_bcs">bcs</a>; vector::tabulate!(<a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec_length">peel_vec_length</a>(), |_| $peel(<a href="../sui/bcs.md#sui_bcs">bcs</a>)) } </code></pre> </details>

Function `peel_vec_address`

Peel a vector of <code>address</code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_address">peel_vec_address</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<address> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_address">peel_vec_address</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<address> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_address">peel_address</a>()) } </code></pre> </details>

Function `peel_vec_bool`

Peel a vector of <code>address</code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_bool">peel_vec_bool</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<bool> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_bool">peel_vec_bool</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<bool> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_bool">peel_bool</a>()) } </code></pre> </details>

Function `peel_vec_u8`

Peel a vector of <code>u8</code> (eg string) from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u8">peel_vec_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u8">peel_vec_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<u8> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u8">peel_u8</a>()) } </code></pre> </details>

Function `peel_vec_vec_u8`

Peel a <code>vector<vector<u8>></code> (eg vec of string) from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_vec_u8">peel_vec_vec_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<vector<u8>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_vec_u8">peel_vec_vec_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<vector<u8>> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec_u8">peel_vec_u8</a>()) } </code></pre> </details>

Function `peel_vec_u16`

Peel a vector of <code>u16</code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u16">peel_vec_u16</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<u16> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u16">peel_vec_u16</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<u16> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u16">peel_u16</a>()) } </code></pre> </details>

Function `peel_vec_u32`

Peel a vector of <code>u32</code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u32">peel_vec_u32</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<u32> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u32">peel_vec_u32</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<u32> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u32">peel_u32</a>()) } </code></pre> </details>

Function `peel_vec_u64`

Peel a vector of <code>u64</code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u64">peel_vec_u64</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<u64> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u64">peel_vec_u64</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<u64> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u64">peel_u64</a>()) } </code></pre> </details>

Function `peel_vec_u128`

Peel a vector of <code>u128</code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u128">peel_vec_u128</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<u128> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u128">peel_vec_u128</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<u128> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u128">peel_u128</a>()) } </code></pre> </details>

Function `peel_vec_u256`

Peel a vector of <code>u256</code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u256">peel_vec_u256</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): vector<u256> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_vec_u256">peel_vec_u256</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): vector<u256> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec">peel_vec</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u256">peel_u256</a>()) } </code></pre> </details>

Function `peel_enum_tag`

Peel enum from serialized bytes, where <code>$f</code> takes a <code>tag</code> value and returns the corresponding enum variant. Move enums are limited to 127 variants, however the tag can be any <code>u32</code> value.

Example:

rust

let my_enum = match (bcs.peel_enum_tag()) {
0 => Enum::Empty,
1 => Enum::U8(bcs.peel_u8()),
2 => Enum::U16(bcs.peel_u16()),
3 => Enum::Struct { a: bcs.peel_address(), b: bcs.peel_u8() },
_ => abort,
};

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_enum_tag">peel_enum_tag</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): u32 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_enum_tag">peel_enum_tag</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): u32 { let tag = <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_vec_length">peel_vec_length</a>(); assert!(tag <= <a href="../std/u32.md#std_u32_max_value">std::u32::max_value</a>!() as u64, <a href="../sui/bcs.md#sui_bcs_EOutOfRange">EOutOfRange</a>); tag as u32 } </code></pre> </details>

Macro function `peel_option`

Peel <code>Option<$T></code> from serialized bytes, where <code>$peel: |&mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>| -> $T</code> gives the functionality of peeling the inner value.

<pre><code>public macro fun <a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a><$T>($<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>, $peel: |&mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>| -> $T): <a href="../std/option.md#std_option_Option">std::option::Option</a><$T> </code></pre> <details> <summary>Implementation</summary> <pre><code>public macro fun <a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a><$T>($<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>, $peel: |&mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>| -> $T): Option<$T> { let <a href="../sui/bcs.md#sui_bcs">bcs</a> = $<a href="../sui/bcs.md#sui_bcs">bcs</a>; if (<a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_bool">peel_bool</a>()) option::some($peel(<a href="../sui/bcs.md#sui_bcs">bcs</a>)) else option::none() } </code></pre> </details>

Function `peel_option_address`

Peel <code>Option<address></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_address">peel_option_address</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><address> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_address">peel_option_address</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<address> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_address">peel_address</a>()) } </code></pre> </details>

Function `peel_option_bool`

Peel <code>Option<bool></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_bool">peel_option_bool</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><bool> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_bool">peel_option_bool</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<bool> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_bool">peel_bool</a>()) } </code></pre> </details>

Function `peel_option_u8`

Peel <code>Option<u8></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u8">peel_option_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u8">peel_option_u8</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<u8> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u8">peel_u8</a>()) } </code></pre> </details>

Function `peel_option_u16`

Peel <code>Option<u16></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u16">peel_option_u16</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><u16> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u16">peel_option_u16</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<u16> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u16">peel_u16</a>()) } </code></pre> </details>

Function `peel_option_u32`

Peel <code>Option<u32></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u32">peel_option_u32</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><u32> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u32">peel_option_u32</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<u32> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u32">peel_u32</a>()) } </code></pre> </details>

Function `peel_option_u64`

Peel <code>Option<u64></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u64">peel_option_u64</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><u64> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u64">peel_option_u64</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<u64> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u64">peel_u64</a>()) } </code></pre> </details>

Function `peel_option_u128`

Peel <code>Option<u128></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u128">peel_option_u128</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><u128> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u128">peel_option_u128</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<u128> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u128">peel_u128</a>()) } </code></pre> </details>

Function `peel_option_u256`

Peel <code>Option<u256></code> from serialized bytes.

<pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u256">peel_option_u256</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">sui::bcs::BCS</a>): <a href="../std/option.md#std_option_Option">std::option::Option</a><u256> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui/bcs.md#sui_bcs_peel_option_u256">peel_option_u256</a>(<a href="../sui/bcs.md#sui_bcs">bcs</a>: &mut <a href="../sui/bcs.md#sui_bcs_BCS">BCS</a>): Option<u256> { <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_option">peel_option</a>!(|<a href="../sui/bcs.md#sui_bcs">bcs</a>| <a href="../sui/bcs.md#sui_bcs">bcs</a>.<a href="../sui/bcs.md#sui_bcs_peel_u256">peel_u256</a>()) } </code></pre> </details>

Struct BCS

Constants

Function to_bytes

Function new

Function into_remainder_bytes

Function peel_address

Function peel_bool

Function peel_u8

Macro function peel_num

Function peel_u16

Function peel_u32

Function peel_u64

Function peel_u128

Function peel_u256

Function peel_vec_length

Macro function peel_vec

Function peel_vec_address

Function peel_vec_bool

Function peel_vec_u8

Function peel_vec_vec_u8

Function peel_vec_u16

Function peel_vec_u32

Function peel_vec_u64

Function peel_vec_u128

Function peel_vec_u256

Function peel_enum_tag

Macro function peel_option

Function peel_option_address

Function peel_option_bool

Function peel_option_u8

Function peel_option_u16

Function peel_option_u32

Function peel_option_u64

Function peel_option_u128

Function peel_option_u256