Struct Intent 

pub struct Intent {
    pub action: String,
    pub params: BTreeMap<String, String>,
}

A human-readable action with named, canonically-ordered parameters.

Parameters are sorted by key before hashing, so two Intent values with identical fields but different insertion order produce the same hash. This makes intent construction order-independent and audit logs readable.

Examples

use a1::Intent;

let intent = Intent::new("trade.equity").unwrap()
    .param("symbol", "AAPL")
    .param("side", "buy")
    .param("limit_usd", "182.50")
    .param("qty", "100");

let h = intent.hash();
assert_ne!(h, [0u8; 32]);

Fields

action: String

Action identifier (e.g. "trade.equity", "query.portfolio").

params: BTreeMap<String, String>

Named parameters, sorted by key for canonical serialization.

Implementations

impl Intent

pub fn new(action: impl Into<String>) -> Result<Self, A1Error>

Create a new intent. Returns A1Error::WireFormatError if the action string is empty or exceeds MAX_ACTION_LEN.

Examples

use a1::Intent;

let intent = Intent::new("trade.equity").unwrap()
    .param("symbol", "AAPL")
    .param("side", "buy");

assert!(Intent::new("").is_err());

pub fn try_new(action: impl Into<String>) -> Result<Self, A1Error>

Alias for new. Prefer new in new code; retained for API symmetry with try_param.

pub fn param(self, key: impl Into<String>, value: impl Into<String>) -> Self

Attach a named parameter. Replaces any existing value for the same key. Panics on debug if limits are exceeded. Use try_param for validation-critical paths.

pub fn try_param( self, key: impl Into<String>, value: impl Into<String>, ) -> Result<Self, A1Error>

Attach a named parameter. Replaces any existing value for the same key. Returns A1Error::WireFormatError if limits are exceeded.

Keys and values are normalized to lowercase and trimmed to ensure deterministic hashing regardless of how the caller constructs them.

pub fn hash(&self) -> IntentHash

Compute the domain-separated hash of this intent.

Uses a prefix-free canonical encoding: each field is length-prefixed before its content, preventing length-extension and collision attacks.

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 Display for Intent

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

Formats the value using the given formatter.

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