Struct gapi_grpc::google::api::expr::v1alpha1::decl::function_decl::Overload

pub struct Overload {
    pub overload_id: String,
    pub params: Vec<Type>,
    pub type_params: Vec<String>,
    pub result_type: Option<Type>,
    pub is_instance_function: bool,
    pub doc: String,
}

An overload indicates a function’s parameter types and return type, and may optionally include a function body described in terms of [Expr][google.api.expr.v1alpha1.Expr] values.

Functions overloads are declared in either a function or method call-style. For methods, the params[0] is the expected type of the target receiver.

Overloads must have non-overlapping argument types after erasure of all parameterized type variables (similar as type erasure in Java).

Fields

overload_id: String

Required. Globally unique overload name of the function which reflects the function name and argument types.

This will be used by a [Reference][google.api.expr.v1alpha1.Reference] to indicate the overload_id that was resolved for the function name.

params: Vec<Type>

List of function parameter [Type][google.api.expr.v1alpha1.Type] values.

Param types are disjoint after generic type parameters have been replaced with the type DYN. Since the DYN type is compatible with any other type, this means that if A is a type parameter, the function types int<A> and int<int> are not disjoint. Likewise, map<string, string> is not disjoint from map<K, V>.

When the result_type of a function is a generic type param, the type param name also appears as the type of on at least one params.

type_params: Vec<String>

The type param names associated with the function declaration.

For example, function ex<K,V>(K key, map<K, V> map) : V would yield the type params of K, V.

result_type: Option<Type>

Required. The result type of the function. For example, the operator string.isEmpty() would have result_type of kind: BOOL.

is_instance_function: bool

Whether the function is to be used in a method call-style x.f(...) of a function call-style f(x, ...).

For methods, the first parameter declaration, params[0] is the expected type of the target receiver.

doc: String

Documentation string for the overload.

Trait Implementations

impl Clone for Overload

fn clone(&self) -> Overload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Overload

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

Formats the value using the given formatter.

impl Default for Overload

fn default() -> Overload

Returns the “default value” for a type.

impl Message for Overload

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<Overload> for Overload

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Overload