Struct Encoder

pub struct Encoder { /* private fields */ }

An ABI encoder.

This is not intended for public consumption. It should be used only by the token types. If you have found yourself here, you probably want to use the high-level crate::SolType interface (or its dynamic equivalent) instead.

Implementations

impl Encoder

pub const fn new() -> Self

Instantiate a new empty encoder.

pub fn with_capacity(size: usize) -> Self

Instantiate a new encoder with a given capacity in words.

pub fn finish(self) -> Vec<Word>

Finish the encoding process, returning the encoded words.

Use into_bytes instead to flatten the words into bytes.

pub fn into_bytes(self) -> Vec<u8>

Finish the encoding process, returning the encoded bytes.

pub fn suffix_offset(&self) -> usize

Determine the current suffix offset.

Panics

Panics if there is no current suffix offset.

pub fn push_offset(&mut self, words: usize)

Appends a suffix offset.

pub fn pop_offset(&mut self) -> Option<usize>

Removes the last offset and returns it.

pub fn bump_offset(&mut self, words: usize)

Bump the suffix offset by a given number of words.

pub fn append_word(&mut self, word: Word)

Append a word to the encoder.

pub fn append_indirection(&mut self)

Append a pointer to the current suffix offset.

Panics

Panics if there is no current suffix offset.

pub fn append_seq_len(&mut self, len: usize)

Append a sequence length.

pub fn append_packed_seq(&mut self, bytes: &[u8])

Append a sequence of bytes as a packed sequence with a length prefix.

pub fn append_head_tail<'a, T: TokenSeq<'a>>(&mut self, token: &T)

Shortcut for appending a token sequence.

Trait Implementations

impl Clone for Encoder

fn clone(&self) -> Encoder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Encoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Encoder

fn default() -> Encoder

Returns the “default value” for a type.