Struct Input

#[non_exhaustive]
pub struct Input {
    pub kind: Option<i32>,
    pub pure: Option<Bytes>,
    pub object_id: Option<String>,
    pub version: Option<u64>,
    pub digest: Option<String>,
    pub mutable: Option<bool>,
    pub literal: Option<Box<Value>>,
}

An input to a user transaction.

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.

kind: Option<i32>

pure: Option<Bytes>

A move value serialized as BCS.

For normal operations this is required to be a move primitive type and not contain structs or objects.

object_id: Option<String>

ObjectId of the object input.

version: Option<u64>

Requested version of the input object when kind is IMMUTABLE_OR_OWNED or RECEIVING or if kind is SHARED this is the initial version of the object when it was shared

digest: Option<String>

The digest of this object.

mutable: Option<bool>

Controls whether the caller asks for a mutable reference to the shared object.

literal: Option<Box<Value>>

A literal value

INPUT ONLY

Implementations

impl Input

pub const KIND_FIELD: &'static MessageField

pub const PURE_FIELD: &'static MessageField

pub const OBJECT_ID_FIELD: &'static MessageField

pub const VERSION_FIELD: &'static MessageField

pub const DIGEST_FIELD: &'static MessageField

pub const MUTABLE_FIELD: &'static MessageField

pub const LITERAL_FIELD: &'static MessageField

impl Input

pub fn path_builder() -> InputFieldPathBuilder

impl Input

pub const fn const_default() -> Self

pub fn with_kind<T: Into<InputKind>>(self, field: T) -> Self

Sets kind with the provided value.

pub fn pure_opt(&self) -> Option<&[u8]>

If pure is set, returns Some with the value; otherwise returns None.

pub fn set_pure<T: Into<Bytes>>(&mut self, field: T)

Sets pure with the provided value.

pub fn with_pure<T: Into<Bytes>>(self, field: T) -> Self

Sets pure with the provided value.

pub fn object_id_opt_mut(&mut self) -> Option<&mut String>

If object_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn object_id_mut(&mut self) -> &mut String

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

pub fn object_id_opt(&self) -> Option<&str>

If object_id is set, returns Some with the value; otherwise returns None.

pub fn set_object_id<T: Into<String>>(&mut self, field: T)

Sets object_id with the provided value.

pub fn with_object_id<T: Into<String>>(self, field: T) -> Self

Sets object_id with the provided value.

pub fn version_opt_mut(&mut self) -> Option<&mut u64>

If version is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn version_mut(&mut self) -> &mut u64

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

pub fn version_opt(&self) -> Option<u64>

If version is set, returns Some with the value; otherwise returns None.

pub fn set_version<T: Into<u64>>(&mut self, field: T)

Sets version with the provided value.

pub fn with_version<T: Into<u64>>(self, field: T) -> Self

Sets version with the provided value.

pub fn digest_opt_mut(&mut self) -> Option<&mut String>

If digest is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn digest_mut(&mut self) -> &mut String

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

pub fn digest_opt(&self) -> Option<&str>

If digest is set, returns Some with the value; otherwise returns None.

pub fn set_digest<T: Into<String>>(&mut self, field: T)

Sets digest with the provided value.

pub fn with_digest<T: Into<String>>(self, field: T) -> Self

Sets digest with the provided value.

pub fn mutable_opt_mut(&mut self) -> Option<&mut bool>

If mutable is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn mutable_mut(&mut self) -> &mut bool

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

pub fn mutable_opt(&self) -> Option<bool>

If mutable is set, returns Some with the value; otherwise returns None.

pub fn set_mutable<T: Into<bool>>(&mut self, field: T)

Sets mutable with the provided value.

pub fn with_mutable<T: Into<bool>>(self, field: T) -> Self

Sets mutable with the provided value.

pub fn literal_opt_mut(&mut self) -> Option<&mut Value>

If literal is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn literal_mut(&mut self) -> &mut Value

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

pub fn literal_opt(&self) -> Option<&Value>

If literal is set, returns Some with the value; otherwise returns None.

pub fn set_literal<T: Into<Value>>(&mut self, field: T)

Sets literal with the provided value.

pub fn with_literal<T: Into<Value>>(self, field: T) -> Self

Sets literal with the provided value.

impl Input

pub fn kind(&self) -> InputKind

Returns the enum value of kind, or the default if the field is unset or set to an invalid enum value.

pub fn set_kind(&mut self, value: InputKind)

Sets kind to the provided enum value.

pub fn pure(&self) -> &[u8]

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

pub fn object_id(&self) -> &str

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

pub fn version(&self) -> u64

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

pub fn digest(&self) -> &str

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

pub fn mutable(&self) -> bool

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

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Input

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Input> for Input

fn from(value: Input) -> Self

Converts to this type from the input type.

impl Message for Input

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 Input

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

impl PartialEq for Input

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Input> for Input

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &Input) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Input