Struct IotaDID

pub struct IotaDID(/* private fields */);

A DID conforming to the IOTA DID method specification.

This is a thin wrapper around the DID type from the identity_did crate.

Implementations

impl IotaDID

pub const SCHEME: &'static str = CoreDID::SCHEME

The URL scheme for Decentralized Identifiers.

pub const METHOD: &'static str = "iota"

The IOTA DID method name ("iota").

pub const DEFAULT_NETWORK: &'static str = "iota"

The default network name ("iota").

pub const PLACEHOLDER_TAG: &'static str = "0x0000000000000000000000000000000000000000000000000000000000000000"

The tag of the placeholder DID.

pub fn new(bytes: &[u8; 32], network_name: &NetworkName) -> IotaDID

Constructs a new IotaDID from a byte representation of the tag and the given network name.

See also IotaDID::placeholder.

Example

let did = IotaDID::new(&[1;32], &NetworkName::try_from("smr").unwrap());
assert_eq!(did.as_str(), "did:iota:smr:0x0101010101010101010101010101010101010101010101010101010101010101");

pub fn from_object_id(object_id: &str, network_name: &NetworkName) -> IotaDID

Constructs a new IotaDID from an identity’s object id and the given network_name.

pub fn placeholder(network_name: &NetworkName) -> IotaDID

Creates a new placeholder IotaDID with the given network name.

Example

let placeholder = IotaDID::placeholder(&NetworkName::try_from("smr").unwrap());
assert_eq!(placeholder.as_str(), "did:iota:smr:0x0000000000000000000000000000000000000000000000000000000000000000");
assert!(placeholder.is_placeholder());

pub fn is_placeholder(&self) -> bool

Returns whether this is the placeholder DID.

Example

let placeholder = IotaDID::placeholder(&NetworkName::try_from("smr").unwrap());
assert!(placeholder.is_placeholder());

pub fn parse(input: impl AsRef<str>) -> Result<IotaDID, Error>

Parses an IotaDID from the given input.

Errors

Returns Err if the input does not conform to the IotaDID specification.

pub fn try_from_core(did: CoreDID) -> Result<IotaDID, Error>

Converts a CoreDID to a IotaDID.

Errors

Returns Err if the input does not conform to the IotaDID specification.

pub fn network_str(&self) -> &str

Returns the IOTA network name of the DID.

pub fn tag_str(&self) -> &str

Returns the tag of the DID, which is an identity’s object id.

pub fn check_validity<D>(did: &D) -> Result<(), Error>

where D: DID,

Checks if the given DID is syntactically valid according to the IotaDID method specification.

Errors

Returns Err if the input is not a syntactically valid IotaDID.

pub fn is_valid(did: &CoreDID) -> bool

Returns a bool indicating if the given DID is valid according to the IotaDID method specification.

Equivalent to IotaDID::check_validity(did).is_ok().

Trait Implementations

impl AsRef<CoreDID> for IotaDID

fn as_ref(&self) -> &CoreDID

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

impl Clone for IotaDID

fn clone(&self) -> IotaDID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IotaDID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IotaDID

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IotaDID

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

Formats the value using the given formatter.

impl From<IotaDID> for CoreDID

fn from(id: IotaDID) -> CoreDID

Converts to this type from the input type.

impl From<IotaDID> for String

fn from(did: IotaDID) -> String

Converts to this type from the input type.

impl FromStr for IotaDID

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<IotaDID, <IotaDID as FromStr>::Err>

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

impl Hash for IotaDID

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 KeyComparable for IotaDID

type Key = CoreDID

Key type for comparisons.

fn key(&self) -> &<IotaDID as KeyComparable>::Key

Returns a reference to the key.

impl Ord for IotaDID

fn cmp(&self, other: &IotaDID) -> Ordering

This method returns an Ordering between self and other.

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 PartialEq for IotaDID

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

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

This method returns an ordering between self and other values if one exists.

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 Serialize for IotaDID

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for IotaDID

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: &str) -> Result<IotaDID, <IotaDID as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<DID> for IotaDID

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: DID) -> Result<IotaDID, Error>

Performs the conversion.

impl TryFrom<CoreDID> for IotaDID

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: CoreDID, ) -> Result<IotaDID, <IotaDID as TryFrom<CoreDID>>::Error>

Performs the conversion.

impl TryFrom<String> for IotaDID

type Error = Error

The type returned in the event of a conversion error.

fn try_from( other: String, ) -> Result<IotaDID, <IotaDID as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for IotaDID

impl StructuralPartialEq for IotaDID