Struct offchain::identifier::Intent

pub struct Intent { /* fields omitted */ }

Intent is a struct holdind data decoded from Diem Intent Identifier string https://dip.diem.com/dip-5/#format

Implementations

impl Intent

pub fn to_encoded_string(&self) -> Result<String, IntentIdentifierError>

Encode Intent as a Diem intent identifier (https://dip.diem.com/dip-5/).

Example

use offchain::identifier::Intent;
use std::str::FromStr;
let identifier = "diem://dm1p7ujcndcl7nudzwt8fglhx6wxn08kgs5tm6mz4us2vfufk?c=XUS&am=4500";
let intent = Intent::from_str(identifier).unwrap();
assert_eq!(intent.to_encoded_string().unwrap(), identifier);

pub fn account_address(&self) -> &AccountAddress

pub fn subaddress(&self) -> &Subaddress

pub fn currency(&self) -> Option<Currency>

pub fn amount(&self) -> Option<u64>

pub fn hrp(&self) -> &HumanReadablePrefix

Trait Implementations

impl Clone for Intent

fn clone(&self) -> Intent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl FromStr for Intent

fn from_str(
    encoded_intent_identifier: &str
) -> Result<Intent, IntentIdentifierError>

Decode Diem intent identifier (https://dip.diem.com/dip-5/) int 3 parts:

1. account identifier: account address & sub-address
2. currency
3. amount

Example

use offchain::identifier::HumanReadablePrefix;
use offchain::identifier::Intent;
use std::str::FromStr;
let identifier = "diem://dm1p7ujcndcl7nudzwt8fglhx6wxn08kgs5tm6mz4us2vfufk?c=XUS&am=4500";
let intent = Intent::from_str(identifier).unwrap();
assert_eq!(intent.hrp(), &HumanReadablePrefix::DM);
assert_eq!(intent.amount(), Some(4500));

type Err = IntentIdentifierError

The associated error which can be returned from parsing.

impl Hash for Intent

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Intent

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Intent> for Intent

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

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

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

This method tests for !=.

impl PartialOrd<Intent> for Intent

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Intent

impl StructuralEq for Intent

impl StructuralPartialEq for Intent