Struct cosmwasm_std::Response
source · [−]#[non_exhaustive]pub struct Response<T = Empty> {
pub messages: Vec<SubMsg<T>>,
pub attributes: Vec<Attribute>,
pub events: Vec<Event>,
pub data: Option<Binary>,
}
Expand description
A response of a contract entry point, such as instantiate
, execute
or migrate
.
This type can be constructed directly at the end of the call. Alternatively a mutable response instance can be created early in the contract’s logic and incrementally be updated.
Examples
Direct:
use cosmwasm_std::{attr, Response, StdResult};
pub fn instantiate(
deps: DepsMut,
_env: Env,
_info: MessageInfo,
msg: InstantiateMsg,
) -> StdResult<Response> {
// ...
Ok(Response::new().add_attribute("action", "instantiate"))
}
Mutating:
use cosmwasm_std::Response;
pub fn instantiate(
deps: DepsMut,
_env: Env,
info: MessageInfo,
msg: InstantiateMsg,
) -> Result<Response, MyError> {
let mut response = Response::new()
.add_attribute("Let the", "hacking begin")
.add_message(BankMsg::Send {
to_address: String::from("recipient"),
amount: coins(128, "uint"),
})
.add_attribute("foo", "bar")
.set_data(b"the result data");
Ok(response)
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.messages: Vec<SubMsg<T>>
Optional list of messages to pass. These will be executed in order.
If the ReplyOn variant matches the result (Always, Success on Ok, Error on Err),
the runtime will invoke this contract’s reply
entry point
after execution. Otherwise, they act like “fire and forget”.
Use SubMsg::new
to create messages with the older “fire and forget” semantics.
attributes: Vec<Attribute>
The attributes that will be emitted as part of a “wasm” event.
More info about events (and their attributes) can be found in Cosmos SDK docs.
events: Vec<Event>
Extra, custom events separate from the main wasm
one. These will have
wasm-
prepended to the type.
More info about events can be found in Cosmos SDK docs.
data: Option<Binary>
The binary payload to include in the response.
Implementations
sourceimpl<T> Response<T>
impl<T> Response<T>
pub fn new() -> Self
sourcepub fn add_attribute(
self,
key: impl Into<String>,
value: impl Into<String>
) -> Self
pub fn add_attribute(
self,
key: impl Into<String>,
value: impl Into<String>
) -> Self
Add an attribute included in the main wasm
event.
For working with optional values or optional attributes, see add_attributes
.
sourcepub fn add_message(self, msg: impl Into<CosmosMsg<T>>) -> Self
pub fn add_message(self, msg: impl Into<CosmosMsg<T>>) -> Self
This creates a “fire and forget” message, by using SubMsg::new()
to wrap it,
and adds it to the list of messages to process.
sourcepub fn add_submessage(self, msg: SubMsg<T>) -> Self
pub fn add_submessage(self, msg: SubMsg<T>) -> Self
This takes an explicit SubMsg (creates via eg. reply_on_error
)
and adds it to the list of messages to process.
sourcepub fn add_event(self, event: Event) -> Self
pub fn add_event(self, event: Event) -> Self
Adds an extra event to the response, separate from the main wasm
event
that is always created.
The wasm-
prefix will be appended by the runtime to the provided type
of event.
sourcepub fn add_attributes<A: Into<Attribute>>(
self,
attrs: impl IntoIterator<Item = A>
) -> Self
pub fn add_attributes<A: Into<Attribute>>(
self,
attrs: impl IntoIterator<Item = A>
) -> Self
Bulk add attributes included in the main wasm
event.
Anything that can be turned into an iterator and yields something
that can be converted into an Attribute
is accepted.
Examples
Adding a list of attributes using the pair notation for key and value:
use cosmwasm_std::Response;
let attrs = vec![
("action", "reaction"),
("answer", "42"),
("another", "attribute"),
];
let res: Response = Response::new().add_attributes(attrs.clone());
assert_eq!(res.attributes, attrs);
Adding an optional value as an optional attribute by turning it into a list of 0 or 1 elements:
use cosmwasm_std::{Attribute, Response};
// Some value
let value: Option<String> = Some("sarah".to_string());
let attribute: Option<Attribute> = value.map(|v| Attribute::new("winner", v));
let res: Response = Response::new().add_attributes(attribute);
assert_eq!(res.attributes, [Attribute {
key: "winner".to_string(),
value: "sarah".to_string(),
}]);
// No value
let value: Option<String> = None;
let attribute: Option<Attribute> = value.map(|v| Attribute::new("winner", v));
let res: Response = Response::new().add_attributes(attribute);
assert_eq!(res.attributes.len(), 0);
sourcepub fn add_messages<M: Into<CosmosMsg<T>>>(
self,
msgs: impl IntoIterator<Item = M>
) -> Self
pub fn add_messages<M: Into<CosmosMsg<T>>>(
self,
msgs: impl IntoIterator<Item = M>
) -> Self
Bulk add “fire and forget” messages to the list of messages to process.
Examples
use cosmwasm_std::{CosmosMsg, Response};
fn make_response_with_msgs(msgs: Vec<CosmosMsg>) -> Response {
Response::new().add_messages(msgs)
}
sourcepub fn add_submessages(self, msgs: impl IntoIterator<Item = SubMsg<T>>) -> Self
pub fn add_submessages(self, msgs: impl IntoIterator<Item = SubMsg<T>>) -> Self
Bulk add explicit SubMsg structs to the list of messages to process.
Examples
use cosmwasm_std::{SubMsg, Response};
fn make_response_with_submsgs(msgs: Vec<SubMsg>) -> Response {
Response::new().add_submessages(msgs)
}
sourcepub fn add_events(self, events: impl IntoIterator<Item = Event>) -> Self
pub fn add_events(self, events: impl IntoIterator<Item = Event>) -> Self
Bulk add custom events to the response. These are separate from the main
wasm
event.
The wasm-
prefix will be appended by the runtime to the provided types
of events.
Trait Implementations
sourceimpl<'de, T> Deserialize<'de> for Response<T> where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for Response<T> where
T: Deserialize<'de>,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<T: JsonSchema> JsonSchema for Response<T>
impl<T: JsonSchema> JsonSchema for Response<T>
sourcefn schema_name() -> String
fn schema_name() -> String
The name of the generated JSON Schema. Read more
sourcefn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
sourcefn is_referenceable() -> bool
fn is_referenceable() -> bool
Whether JSON Schemas generated for this type should be re-used where possible using the $ref
keyword. Read more
impl<T> StructuralPartialEq for Response<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for Response<T> where
T: RefUnwindSafe,
impl<T> Send for Response<T> where
T: Send,
impl<T> Sync for Response<T> where
T: Sync,
impl<T> Unpin for Response<T> where
T: Unpin,
impl<T> UnwindSafe for Response<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more