Struct CommandResult

#[non_exhaustive]
pub struct CommandResult {
    pub return_values: Vec<CommandOutput>,
    pub mutated_by_ref: Vec<CommandOutput>,
}

An intermediate result/output from the execution of a single command

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

return_values: Vec<CommandOutput>

mutated_by_ref: Vec<CommandOutput>

Implementations

impl CommandResult

pub const RETURN_VALUES_FIELD: &'static MessageField

pub const MUTATED_BY_REF_FIELD: &'static MessageField

impl CommandResult

pub fn path_builder() -> CommandResultFieldPathBuilder

impl CommandResult

pub const fn const_default() -> Self

pub fn return_values(&self) -> &[CommandOutput]

Returns the value of return_values, or the default value if return_values is unset.

pub fn return_values_mut(&mut self) -> &mut Vec<CommandOutput>

Returns a mutable reference to return_values. If the field is unset, it is first initialized with the default value.

pub fn set_return_values(&mut self, field: Vec<CommandOutput>)

Sets return_values with the provided value.

pub fn with_return_values(self, field: Vec<CommandOutput>) -> Self

Sets return_values with the provided value.

pub fn mutated_by_ref(&self) -> &[CommandOutput]

Returns the value of mutated_by_ref, or the default value if mutated_by_ref is unset.

pub fn mutated_by_ref_mut(&mut self) -> &mut Vec<CommandOutput>

Returns a mutable reference to mutated_by_ref. If the field is unset, it is first initialized with the default value.

pub fn set_mutated_by_ref(&mut self, field: Vec<CommandOutput>)

Sets mutated_by_ref with the provided value.

pub fn with_mutated_by_ref(self, field: Vec<CommandOutput>) -> Self

Sets mutated_by_ref with the provided value.

Trait Implementations

impl Clone for CommandResult

fn clone(&self) -> CommandResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandResult

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

Formats the value using the given formatter.

impl Default for CommandResult

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommandResult

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for CommandResult

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 MessageFields for CommandResult

const FIELDS: &'static [&'static MessageField]

impl PartialEq for CommandResult

fn eq(&self, other: &CommandResult) -> 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 CommandResult

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 CommandResult