Struct ProgramID

pub struct ProgramID<N>
where
    N: Network,
{ /* private fields */ }

A program ID is of the form {name}.{network}.

Implementations

impl<N> ProgramID<N>

where N: Network,

pub fn to_address(&self) -> Result<Address<N>, Error>

Returns the program address for this program ID.

impl<N> ProgramID<N>

where N: Network,

pub const fn name(&self) -> &Identifier<N>

Returns the program name.

pub const fn network(&self) -> &Identifier<N>

Returns the network-level domain (NLD).

pub fn is_aleo(&self) -> bool

Returns true if the network-level domain is aleo.

Trait Implementations

impl<N> Clone for ProgramID<N>

where N: Clone + Network,

fn clone(&self) -> ProgramID<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for ProgramID<N>

where N: Network,

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

Prints the program ID as a string.

impl<'de, N> Deserialize<'de> for ProgramID<N>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<ProgramID<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the program ID from a string or bytes.

impl<N> Display for ProgramID<N>

where N: Network,

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

Prints the program ID as a string.

impl<N> Equal for ProgramID<N>

where N: Network,

fn is_equal(&self, other: &ProgramID<N>) -> <ProgramID<N> as Equal>::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &ProgramID<N>) -> <ProgramID<N> as Equal>::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

impl<N> From<&ProgramID<N>> for ProgramID<N>

where N: Network,

fn from(program_id: &ProgramID<N>) -> ProgramID<N>

Returns a copy of the program ID.

impl<N> FromBytes for ProgramID<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<ProgramID<N>, Error>

where R: Read,

Reads the program ID from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N> FromStr for ProgramID<N>

where N: Network,

fn from_str(string: &str) -> Result<ProgramID<N>, Error>

Parses a string into a program ID.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Hash for ProgramID<N>

where N: Hash + Network,

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<N> Ord for ProgramID<N>

where N: Network,

fn cmp(&self, other: &ProgramID<N>) -> Ordering

Ordering is determined by the network first, then the program name second.

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<N> Parser for ProgramID<N>

where N: Network,

fn parse(string: &str) -> Result<(&str, ProgramID<N>), Err<VerboseError<&str>>>

Parses a string into a program ID of the form {name}.{network}.

impl<N> PartialEq for ProgramID<N>

where N: PartialEq + Network,

fn eq(&self, other: &ProgramID<N>) -> 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<N> PartialOrd for ProgramID<N>

where N: Network,

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

Ordering is determined by the network first, then the program name second.

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<N> Serialize for ProgramID<N>

where N: Network,

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

where S: Serializer,

Serializes the program ID into string or bytes.

impl<N> ToBits for &ProgramID<N>

where N: Network,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the little-endian bits of the program ID.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the big-endian bits of the program ID.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N> ToBits for ProgramID<N>

where N: Network,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the little-endian bits of the program ID.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the big-endian bits of the program ID.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N> ToBytes for ProgramID<N>

where N: Network,

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

where W: Write,

Writes the program ID to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> ToFields for ProgramID<N>

where N: Network,

fn to_fields(&self) -> Result<Vec<<ProgramID<N> as ToFields>::Field>, Error>

Returns this program ID as a list of field elements.

type Field = Field<N>

impl<N> TryFrom<&String> for ProgramID<N>

where N: Network,

fn try_from(program_id: &String) -> Result<ProgramID<N>, Error>

Initializes a program ID from a name and network-level domain identifier.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<&str> for ProgramID<N>

where N: Network,

fn try_from(program_id: &str) -> Result<ProgramID<N>, Error>

Initializes a program ID from a name and network-level domain identifier.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<(Identifier<N>, Identifier<N>)> for ProgramID<N>

where N: Network,

fn try_from(_: (Identifier<N>, Identifier<N>)) -> Result<ProgramID<N>, Error>

Initializes a program ID from a name and network-level domain identifier.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<String> for ProgramID<N>

where N: Network,

fn try_from(program_id: String) -> Result<ProgramID<N>, Error>

Initializes a program ID from a name and network-level domain identifier.

type Error = Error

The type returned in the event of a conversion error.

impl<N> Copy for ProgramID<N>

where N: Copy + Network,

impl<N> Eq for ProgramID<N>

where N: Eq + Network,

impl<N> StructuralPartialEq for ProgramID<N>

where N: Network,