Struct FunctionDescriptor

#[non_exhaustive]
pub struct FunctionDescriptor {
    pub name: Option<String>,
    pub visibility: Option<i32>,
    pub is_entry: Option<bool>,
    pub type_parameters: Vec<TypeParameter>,
    pub parameters: Vec<OpenSignature>,
    pub returns: Vec<OpenSignature>,
}

Descriptor of a Move function

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.

name: Option<String>

Name of the function

visibility: Option<i32>

Whether the function is public, private or public(friend)

is_entry: Option<bool>

Whether the function is marked entry or not.

type_parameters: Vec<TypeParameter>

Ability constraints for type parameters

parameters: Vec<OpenSignature>

Formal parameter types.

returns: Vec<OpenSignature>

Return types.

Implementations

impl FunctionDescriptor

pub const NAME_FIELD: &'static MessageField

pub const VISIBILITY_FIELD: &'static MessageField

pub const IS_ENTRY_FIELD: &'static MessageField

pub const TYPE_PARAMETERS_FIELD: &'static MessageField

pub const PARAMETERS_FIELD: &'static MessageField

pub const RETURNS_FIELD: &'static MessageField

impl FunctionDescriptor

pub fn path_builder() -> FunctionDescriptorFieldPathBuilder

impl FunctionDescriptor

pub const fn const_default() -> Self

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

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

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

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

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

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

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

Sets name with the provided value.

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

Sets name with the provided value.

pub fn with_visibility<T: Into<Visibility>>(self, field: T) -> Self

Sets visibility with the provided value.

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

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

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

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

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

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

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

Sets is_entry with the provided value.

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

Sets is_entry with the provided value.

pub fn type_parameters(&self) -> &[TypeParameter]

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

pub fn type_parameters_mut(&mut self) -> &mut Vec<TypeParameter>

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

pub fn set_type_parameters(&mut self, field: Vec<TypeParameter>)

Sets type_parameters with the provided value.

pub fn with_type_parameters(self, field: Vec<TypeParameter>) -> Self

Sets type_parameters with the provided value.

pub fn parameters(&self) -> &[OpenSignature]

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

pub fn parameters_mut(&mut self) -> &mut Vec<OpenSignature>

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

pub fn set_parameters(&mut self, field: Vec<OpenSignature>)

Sets parameters with the provided value.

pub fn with_parameters(self, field: Vec<OpenSignature>) -> Self

Sets parameters with the provided value.

pub fn returns(&self) -> &[OpenSignature]

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

pub fn returns_mut(&mut self) -> &mut Vec<OpenSignature>

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

pub fn set_returns(&mut self, field: Vec<OpenSignature>)

Sets returns with the provided value.

pub fn with_returns(self, field: Vec<OpenSignature>) -> Self

Sets returns with the provided value.

impl FunctionDescriptor

pub fn name(&self) -> &str

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

pub fn visibility(&self) -> Visibility

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

pub fn set_visibility(&mut self, value: Visibility)

Sets visibility to the provided enum value.

pub fn is_entry(&self) -> bool

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

Trait Implementations

impl Clone for FunctionDescriptor

fn clone(&self) -> FunctionDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDescriptor

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

Formats the value using the given formatter.

impl Default for FunctionDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionDescriptor

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FunctionDescriptor

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 FunctionDescriptor

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

impl PartialEq for FunctionDescriptor

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

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 FunctionDescriptor