Struct ProgramID

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

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

Implementations

impl<N: Network> ProgramID<N>

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

Returns the program address for this program ID.

impl<N: Network> ProgramID<N>

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 + Network> Clone for ProgramID<N>

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: Network> Debug for ProgramID<N>

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

Prints the program ID as a string.

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

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

Deserializes the program ID from a string or bytes.

impl<N: Network> Display for ProgramID<N>

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

Prints the program ID as a string.

impl<N: Network> Equal for ProgramID<N>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

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

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

Returns a copy of the program ID.

impl<N: Network> FromBytes for ProgramID<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

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: Network> FromStr for ProgramID<N>

fn from_str(string: &str) -> Result<Self>

Parses a string into a program ID.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Hash + Network> Hash for ProgramID<N>

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

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

fn cmp(&self, other: &Self) -> 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: Network> Parser for ProgramID<N>

fn parse(string: &str) -> ParserResult<'_, Self>

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

impl<N: PartialEq + Network> PartialEq for ProgramID<N>

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: Network> PartialOrd for ProgramID<N>

fn partial_cmp(&self, other: &Self) -> 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: Network> Serialize for ProgramID<N>

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

Serializes the program ID into string or bytes.

impl<N: Network> ToBits for &ProgramID<N>

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: Network> ToBits for ProgramID<N>

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: Network> ToBytes for ProgramID<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

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: Network> ToFields for ProgramID<N>

fn to_fields(&self) -> Result<Vec<Self::Field>>

Returns this program ID as a list of field elements.

type Field = Field<N>

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

fn try_from(program_id: &String) -> Result<Self>

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: Network> TryFrom<&str> for ProgramID<N>

fn try_from(program_id: &str) -> Result<Self>

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: Network> TryFrom<(Identifier<N>, Identifier<N>)> for ProgramID<N>

fn try_from((name, network): (Identifier<N>, Identifier<N>)) -> Result<Self>

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: Network> TryFrom<String> for ProgramID<N>

fn try_from(program_id: String) -> Result<Self>

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 + Network> Copy for ProgramID<N>

impl<N: Eq + Network> Eq for ProgramID<N>

impl<N: Network> StructuralPartialEq for ProgramID<N>