Struct Request 

pub struct Request {
    pub action: String,
    pub project: String,
    pub settings: Map<String, Value>,
    pub input: Map<String, Value>,
    pub context: Context,
    pub button: Option<String>,
    pub changed: Option<String>,
    pub state: Option<Value>,
    pub resumed: bool,
    pub locale: Option<String>,
}

Fields

action: String

Which of the manifest’s [[actions]] to run.

project: String

settings: Map<String, Value>

The plugin’s declared settings, every key present.

input: Map<String, Value>

A value for each field of the page the user was on; on the first call, the action’s [[actions.field]]s.

context: Context

button: Option<String>

The id of the button pressed; none on the first call, which opens the action or runs the manifest’s fields.

changed: Option<String>

Reserved for fields that call the action when they change; always none.

state: Option<Value>

The last page’s state, as it was written; none on the first call.

resumed: bool

Set on the first call after Hammer restored a run the user had left.

locale: Option<String>

The UI’s BCP 47 tag, for replying in the user’s language; not the project’s language.

Implementations

impl Request

pub fn input<T: DeserializeOwned>(&self) -> Result<T>

The input read into a T, with a field per field of the page.

pub fn state<T: DeserializeOwned>(&self) -> Option<T>

The state read into a T: none when there is none, or it is not a T.

Trait Implementations

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.