Struct identity_iota_client::tangle::ExplorerUrl

#[repr(transparent)]
pub struct ExplorerUrl(_);

A Tangle explorer URL with convenience functions for constructing URLs for viewing published messages or IOTA DIDs.

Example

let explorer = ExplorerUrl::mainnet();
let did = IotaDID::parse("did:iota:H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV")?;
assert_eq!(
  explorer.resolver_url(&did)?,
  "https://explorer.iota.org/mainnet/identity-resolver/did:iota:H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
);

Implementations

impl ExplorerUrl

pub fn new(url: Url) -> Result<Self>

Constructs a new Tangle explorer URL.

Use ExplorerUrl::mainnet or ExplorerUrl::devnet unless using a private Tangle or local explorer.

NOTE: does not validate whether this corresponds to an actual Tangle explorer.

pub fn parse(url: &str) -> Result<Self>

Constructs a new Tangle explorer URL from a string.

See ExplorerUrl::new.

Example

Point to a Tangle explorer deployed locally.

let explorer = ExplorerUrl::parse("http://127.0.0.1:8082/")?;

pub fn mainnet() -> &'static ExplorerUrl

Returns the Tangle explorer URL for the mainnet.

pub fn devnet() -> &'static ExplorerUrl

Returns the Tangle explorer URL for the devnet.

pub fn message_url(&self, message_id: &MessageId) -> Result<Url>

Returns the web explorer URL of the given message_id.

E.g. https://explorer.iota.org/mainnet/message/<message_id>

pub fn resolver_url(&self, did: &impl DID) -> Result<Url>

Returns the web identity resolver URL for the given DID.

E.g. https://explorer.iota.org/mainnet/identity-resolver/<did>

Trait Implementations

impl AsRef<str> for ExplorerUrl

fn as_ref(&self) -> &str

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

impl Clone for ExplorerUrl

fn clone(&self) -> ExplorerUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExplorerUrl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExplorerUrl

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

Deserialize this value from the given Serde deserializer.

impl Display for ExplorerUrl

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

Formats the value using the given formatter.

impl FromStr for ExplorerUrl

type Err = Error

The associated error which can be returned from parsing.

fn from_str(url: &str) -> Result<Self, Self::Err>

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

impl PartialEq<ExplorerUrl> for ExplorerUrl

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ExplorerUrl

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

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ExplorerUrl

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Url> for ExplorerUrl

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ExplorerUrl

impl StructuralEq for ExplorerUrl

impl StructuralPartialEq for ExplorerUrl