Struct Locator 

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

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

Implementations

impl<N> Locator<N>

where N: Network,

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

Initializes a locator from a program ID and resource.

impl<N> Locator<N>

where N: Network,

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 for Locator<N>

where N: Clone + Network,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Locator<N>

where N: Network,

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

Prints the locator as a string.

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

where N: Network,

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

where D: Deserializer<'de>,

Deserializes the locator from a string or bytes.

impl<N> Display for Locator<N>

where N: Network,

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

Prints the locator as a string.

impl<N> From<Locator<N>> for PlaintextType<N>

where N: Network,

fn from(locator: Locator<N>) -> PlaintextType<N>

Initializes a plaintext type from an external struct type.

impl<N> FromBytes for Locator<N>

where N: Network,

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

where R: Read,

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.

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

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N> FromStr for Locator<N>

where N: Network,

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

Parses a string into a locator.

type Err = Error

The associated error which can be returned from parsing.

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

where N: Network,

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

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

impl<N> PartialEq for Locator<N>

where N: PartialEq + Network,

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

where N: Network,

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

where S: Serializer,

Serializes the locator into string or bytes.

impl<N> ToBytes for Locator<N>

where N: Network,

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

where W: Write,

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> ToFields for Locator<N>

where N: Network,

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

Returns this locator as a list of field elements.

type Field = Field<N>

impl<N> Copy for Locator<N>

where N: Copy + Network,

impl<N> Eq for Locator<N>

where N: Eq + Network,

impl<N> StructuralPartialEq for Locator<N>

where N: Network,