Struct LibId

pub struct LibId(/* private fields */);

Unique identifier for an AluVM library.

Methods from Deref<Target = Array<u8, 32>>

pub fn as_slice(&self) -> &[T]

Returns byte slice representation.

pub fn to_vec(&self) -> Vec<T>

where T: Clone,

Returns vector representing internal slice data

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the array items.

The iterator yields all items from start to end.

pub fn to_byte_array(&self) -> [u8; LEN]

Returns a byte array representation stored in the wrapped type.

Trait Implementations

impl AsRef<Array<u8, 32>> for LibId

fn as_ref(&self) -> &Array<u8, 32>

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8]> for LibId

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Borrow<Array<u8, 32>> for LibId

fn borrow(&self) -> &Array<u8, 32>

Immutably borrows from an owned value.

impl<'a, C, D> BytecodeRead<LibId> for Marshaller<'a, C, D>

where C: AsRef<[u8]>, D: AsRef<[u8]>, Marshaller<'a, C, D>: 'a,

fn pos(&self) -> u16

Return the current byte offset of the cursor. Does not account for bits. If the position is exactly at EOF, returns None.

fn seek(&mut self, byte_pos: u16) -> Result<u16, CodeEofError>

Set the current cursor byte offset to the provided value if it is less than the underlying buffer length.

fn is_eof(&self) -> bool

Return whether end of the bytecode is reached.

fn peek_byte(&self) -> Result<u8, CodeEofError>

Peek a single byte without moving cursor.

fn read_bool(&mut self) -> Result<bool, CodeEofError>

Read single bit as a bool value.

fn read_1bit(&mut self) -> Result<u1, CodeEofError>

Read single bit.

fn read_2bits(&mut self) -> Result<u2, CodeEofError>

Read two bits.

fn read_3bits(&mut self) -> Result<u3, CodeEofError>

Read three bits.

fn read_4bits(&mut self) -> Result<u4, CodeEofError>

Read four bits.

fn read_5bits(&mut self) -> Result<u5, CodeEofError>

Read five bits.

fn read_6bits(&mut self) -> Result<u6, CodeEofError>

Read six bits.

fn read_7bits(&mut self) -> Result<u7, CodeEofError>

Read seven bits.

fn read_byte(&mut self) -> Result<u8, CodeEofError>

Read byte.

fn read_word(&mut self) -> Result<u16, CodeEofError>

Read word.

fn read_fixed<N, const LEN: usize>( &mut self, f: impl FnOnce([u8; LEN]) -> N, ) -> Result<N, CodeEofError>

Read the fixed number of bytes and convert it into a result type.

fn read_bytes( &mut self, ) -> Result<(Confined<Vec<u8>, amplify::::collection::confinement::SmallBlob::{constant#0}, amplify::::collection::confinement::SmallBlob::{constant#1}>, bool), CodeEofError>

Read variable-length byte string.

fn read_ref(&mut self) -> Result<LibId, CodeEofError>

where LibId: Sized,

Read external reference id.

fn check_aligned(&self)

Check if the current cursor position is aligned to the next byte.

impl<'a, C, D> BytecodeWrite<LibId> for Marshaller<'a, C, D>

where C: AsRef<[u8]> + AsMut<[u8]> + Extend<u8>, D: AsRef<[u8]> + AsMut<[u8]> + Extend<u8>, Marshaller<'a, C, D>: 'a,

type Error = MarshallError

Error type returned during writing procedures.

fn write_1bit(&mut self, data: u1) -> Result<(), MarshallError>

Write a single bit.

fn write_2bits(&mut self, data: u2) -> Result<(), MarshallError>

Write two bits.

fn write_3bits(&mut self, data: u3) -> Result<(), MarshallError>

Write three bits.

fn write_4bits(&mut self, data: u4) -> Result<(), MarshallError>

Write four bits.

fn write_5bits(&mut self, data: u5) -> Result<(), MarshallError>

Write five bits.

fn write_6bits(&mut self, data: u6) -> Result<(), MarshallError>

Write six bits.

fn write_7bits(&mut self, data: u7) -> Result<(), MarshallError>

Write seven bits.

fn write_byte(&mut self, data: u8) -> Result<(), MarshallError>

Write byte.

fn write_word(&mut self, data: u16) -> Result<(), MarshallError>

Write word.

fn write_fixed<const LEN: usize>( &mut self, data: [u8; LEN], ) -> Result<(), <Marshaller<'a, C, D> as BytecodeWrite<LibId>>::Error>

Write data representable as a fixed-length byte array.

fn write_bytes( &mut self, data: &[u8], ) -> Result<(), <Marshaller<'a, C, D> as BytecodeWrite<LibId>>::Error>

Write variable-length byte string.

fn write_ref( &mut self, id: LibId, ) -> Result<(), <Marshaller<'a, C, D> as BytecodeWrite<LibId>>::Error>

Write external reference id.

fn check_aligned(&self)

Check if the current cursor position is aligned to the next byte.

fn write_bool(&mut self, data: bool) -> Result<(), Self::Error>

Write a single bit from a bool value.

impl Clone for LibId

fn clone(&self) -> LibId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitmentId for LibId

const TAG: &'static str = LIB_ID_TAG

A tag string used in initializing SHA256 hasher.

impl Debug for LibId

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

Formats the value using the given formatter.

impl Default for LibId

fn default() -> LibId

Returns the “default value” for a type.

impl Deref for LibId

type Target = Array<u8, 32>

The resulting type after dereferencing.

fn deref(&self) -> &<LibId as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for LibId

fn deserialize<__D>( __deserializer: __D, ) -> Result<LibId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LibId

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

Formats the value using the given formatter.

impl DisplayBaid64 for LibId

const HRI: &'static str = "alu"

const CHUNKING: bool = true

const PREFIX: bool = true

const EMBED_CHECKSUM: bool = false

const MNEMONIC: bool = true

fn to_baid64_payload(&self) -> [u8; 32]

const CHUNK_FIRST: usize = 8usize

const CHUNK_LEN: usize = 7usize

fn to_baid64_string(&self) -> String

fn to_baid64_mnemonic(&self) -> String

fn display_baid64(&self) -> Baid64Display<LEN>

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

impl From<[u8; 32]> for LibId

fn from(v: [u8; 32]) -> LibId

Converts to this type from the input type.

impl From<Array<u8, 32>> for LibId

fn from(v: Array<u8, 32>) -> LibId

Converts to this type from the input type.

impl From<LibId> for Array<u8, 32>

fn from(wrapped: LibId) -> Array<u8, 32>

Converts to this type from the input type.

impl FromBaid64Str for LibId

fn from_baid64_str(s: &str) -> Result<Self, Baid64ParseError>

impl FromHex for LibId

fn from_byte_iter<I>(iter: I) -> Result<LibId, Error>

where I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator,

Produce an object from a byte iterator

fn from_hex(s: &str) -> Result<Self, Error>

Produce an object from a hex string

impl FromStr for LibId

type Err = Baid64ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<LibId, <LibId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for LibId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<Range<usize>> for LibId

type Output = <Array<u8, 32> as Index<Range<usize>>>::Output

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &<LibId as Index<Range<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for LibId

type Output = <Array<u8, 32> as Index<RangeFrom<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeFrom<usize>, ) -> &<LibId as Index<RangeFrom<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for LibId

type Output = <Array<u8, 32> as Index<RangeFull>>::Output

The returned type after indexing.

fn index(&self, index: RangeFull) -> &<LibId as Index<RangeFull>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for LibId

type Output = <Array<u8, 32> as Index<RangeInclusive<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeInclusive<usize>, ) -> &<LibId as Index<RangeInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for LibId

type Output = <Array<u8, 32> as Index<RangeTo<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeTo<usize>, ) -> &<LibId as Index<RangeTo<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for LibId

type Output = <Array<u8, 32> as Index<RangeInclusive<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeToInclusive<usize>, ) -> &<LibId as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for LibId

type Output = <Array<u8, 32> as Index<usize>>::Output

The returned type after indexing.

fn index(&self, index: usize) -> &<LibId as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl LowerHex for LibId

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

Formats the value using the given formatter.

impl Ord for LibId

fn cmp(&self, other: &LibId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LibId

fn eq(&self, other: &LibId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LibId

fn partial_cmp(&self, other: &LibId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LibId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for LibId

fn strict_decode(reader: &mut impl TypedRead) -> Result<LibId, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictEncode for LibId

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictTuple for LibId

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for LibId

const STRICT_LIB_NAME: &'static str = LIB_NAME_ALUVM

fn strict_name() -> Option<TypeName>

impl UpperHex for LibId

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

Formats the value using the given formatter.

impl Wrapper for LibId

type Inner = Array<u8, 32>

Inner type wrapped by the current newtype

fn from_inner(inner: <LibId as Wrapper>::Inner) -> LibId

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &<LibId as Wrapper>::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> <LibId as Wrapper>::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl Copy for LibId

impl Eq for LibId

impl SiteId for LibId

impl StrictProduct for LibId

impl StructuralPartialEq for LibId