Struct RunFunctionResponse 

pub struct RunFunctionResponse {
    pub meta: Option<ResponseMeta>,
    pub desired: Option<State>,
    pub results: Vec<Result>,
    pub context: Option<Struct>,
    pub requirements: Option<Requirements>,
    pub conditions: Vec<Condition>,
    pub output: Option<Struct>,
}

A RunFunctionResponse contains the result of a function run.

Fields

meta: Option<ResponseMeta>

Metadata pertaining to this response.

desired: Option<State>

Desired state according to a function pipeline. functions may add desired state, and may mutate or delete any part of the desired state they are concerned with. A function must pass through any part of the desired state that it is not concerned with.

Note that the desired state must be a partial object with only the fields that this function (and its predecessors in the pipeline) wants to have set in the object. Copying a non-partial observed state to desired is most likely not what you want to do. Leaving out fields that had been returned as desired before will result in them being deleted from the objects in the cluster.

results: Vec<Result>

Results of the function run. Results are used for observability purposes.

context: Option<Struct>

Optional context to be passed to the next function in the pipeline as part of the RunFunctionRequest. Dropped on the last function in the pipeline.

requirements: Option<Requirements>

Requirements that must be satisfied for this function to run successfully.

conditions: Vec<Condition>

Status conditions to be applied to the XR. Conditions may also optionally be applied to the XR’s associated claim.

Conditions are only used for composition. They’re ignored by Operations.

output: Option<Struct>

Optional output specific to this function invocation.

Only Operations use function output. XRs will discard any function output.

Trait Implementations

impl Clone for RunFunctionResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunFunctionResponse

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

Formats the value using the given formatter.

impl Default for RunFunctionResponse

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunFunctionResponse

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RunFunctionResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RunFunctionResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RunFunctionResponse

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunFunctionResponse