Struct Locator

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

A locator is of the form {program_id}/{resource} (i.e. howard.aleo/notify).

Implementations

impl<N: Network> Locator<N>

pub const fn new(program_id: ProgramID<N>, resource: Identifier<N>) -> Self

Initializes a locator from a program ID and resource.

impl<N: Network> Locator<N>

pub const fn program_id(&self) -> &ProgramID<N>

Returns the program ID.

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 const fn resource(&self) -> &Identifier<N>

Returns the resource name.

Trait Implementations

impl<N: Clone + Network> Clone for Locator<N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Locator<N>

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

Prints the locator as a string.

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

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

Deserializes the locator from a string or bytes.

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

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

Prints the locator as a string.

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

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

Reads the locator 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 Locator<N>

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

Parses a string into a locator.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Hash + Network> Hash for Locator<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> Parser for Locator<N>

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

Parses a string into a locator of the form {program_id}/{resource}.

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

fn eq(&self, other: &Locator<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> Serialize for Locator<N>

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

Serializes the locator into string or bytes.

impl<N: Network> ToBytes for Locator<N>

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

Writes the locator 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 Locator<N>

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

Returns this locator as a list of field elements.

type Field = Field<N>

impl<N: Copy + Network> Copy for Locator<N>

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

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