Struct protos::sp_wsm::WASMResponse

pub struct WASMResponse {
    pub output_payload: Vec<u8>,
    pub exit_code: EnumOrUnknown<WASMExitCode>,
    pub exit_msg: String,
    pub output_step: Option<Vec<u8>>,
    pub inter_step_result: MessageField<InterStepResult>,
    pub special_fields: SpecialFields,
}

Returned by all WASM functions

Fields

output_payload: Vec<u8>

Potentially modified input payload. Concept: All WASM funcs accept an input_payload in WASMRequest, WASM func reads input payload, modifies it and writes the modified output to output_payload.

exit_code: EnumOrUnknown<WASMExitCode>

Exit code that the WASM func exited with; more info in WASMExitCode’s comment

exit_msg: String

Additional info about the reason a specific exit code was returned

output_step: Option<Vec<u8>>

Potential additional step output - ie. if a WASM func is an HTTPGet, output_step would contain the HTTP response body; if the WASM func is a KVGet, the output_step would be the value of the fetched key.

inter_step_result: MessageField<InterStepResult>

If Step.Dynamic == true, this field should be filled out by the WASM module This is used for communicating data between steps. For example, when trying to find email addresses in a payload and then passing on the results to a transform step to obfuscate them

special_fields: SpecialFields

Implementations

impl WASMResponse

pub fn new() -> WASMResponse

Trait Implementations

impl Clone for WASMResponse

fn clone(&self) -> WASMResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WASMResponse

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

Formats the value using the given formatter.

impl<'a> Default for &'a WASMResponse

fn default() -> &'a WASMResponse

Returns the “default value” for a type.

impl Default for WASMResponse

fn default() -> WASMResponse

Returns the “default value” for a type.

impl Display for WASMResponse

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

Formats the value using the given formatter.

impl Message for WASMResponse

const NAME: &'static str = "WASMResponse"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_> ) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> WASMResponse

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static WASMResponse

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, Error>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), Error>

Write the message to the stream.

fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_> ) -> Result<(), Error>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<(), Error>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), Error>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, Error>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self, Error>

Parse message from byte array.

fn check_initialized(&self) -> Result<(), Error>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), Error>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<(), Error>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to bytes vec.

fn write_length_delimited_to_writer( &self, w: &mut dyn Write ) -> Result<(), Error>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for WASMResponse

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq for WASMResponse

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProtobufValue for WASMResponse

type RuntimeType = RuntimeTypeMessage<WASMResponse>

Actual implementation of type properties.

impl StructuralPartialEq for WASMResponse