Struct Intent

pub struct Intent {
    pub scope: IntentScope,
    pub version: IntentVersion,
    pub app_id: AppId,
}

An intent is a compact struct serves as the domain separator for a message that a signature commits to. It consists of three parts: [enum IntentScope] (what the type of the message is), [enum IntentVersion], [enum AppId] (what application that the signature refers to). It is used to construct [struct IntentMessage] that what a signature commits to.

The serialization of an Intent is a 3-byte array where each field is represented by a byte.

Fields

scope: IntentScope

version: IntentVersion

app_id: AppId

Implementations

impl Intent

pub fn to_bytes(&self) -> [u8; 3]

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Report>

impl Intent

pub fn sui_app(scope: IntentScope) -> Self

pub fn sui_transaction() -> Self

pub fn personal_message() -> Self

pub fn narwhal_app(scope: IntentScope) -> Self

pub fn consensus_app(scope: IntentScope) -> Self

Trait Implementations

impl Clone for Intent

fn clone(&self) -> Intent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Intent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Intent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Intent

type Err = Report

The associated error which can be returned from parsing.

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

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

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Intent

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Intent

impl StructuralPartialEq for Intent