Struct Function

#[non_exhaustive]
pub struct Function<'a> {
    pub id: &'a str,
    pub description: &'a str,
    pub declaration: &'a str,
    pub visibility: Visibility,
    pub mutability: Mutability,
    pub signature: &'a str,
    pub selector: &'a str,
    pub selector_bytes: [u8; 4],
}

Solidity 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.

id: &'a str

The function’s unique identifier. This is the function name, optionally appended with an index if it is overloaded.

description: &'a str

The description of the function. This is a markdown string derived from the NatSpec documentation.

declaration: &'a str

The Solidity function declaration, including full type and parameter names, visibility, etc.

visibility: Visibility

The Solidity function visibility attribute. This is currently always external, but this may change in the future.

mutability: Mutability

The Solidity function state mutability attribute.

signature: &'a str

The standard function signature used to calculate selector. See the Solidity docs for more information.

selector: &'a str

The hex-encoded, “0x”-prefixed 4-byte function selector, which is the Keccak-256 hash of signature.

selector_bytes: [u8; 4]

The 4-byte function selector as a byte array.

Trait Implementations

impl<'a> Clone for Function<'a>

fn clone(&self) -> Function<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Function<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Function<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Function<'_>

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

Formats the value using the given formatter.

impl<'a> JsonSchema for Function<'a>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<'a> Ord for Function<'a>

fn cmp(&self, other: &Function<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Function<'a>

fn eq(&self, other: &Function<'a>) -> 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<'a> PartialOrd for Function<'a>

fn partial_cmp(&self, other: &Function<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for Function<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Function<'a>

impl<'a> StructuralPartialEq for Function<'a>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 88 bytes