Struct Method

#[non_exhaustive]
pub struct Method {
    pub name: Ident,
    pub docs: Docs,
    pub full_path_name: Ident,
    pub self_param: Option<SelfParam>,
    pub params: Vec<Param>,
    pub return_type: Option<TypeName>,
    pub lifetime_env: LifetimeEnv,
    pub attrs: Attrs,
}

A method declared in the impl associated with an FFI struct. Includes both static and non-static methods, which can be distinguished by inspecting Method::self_param.

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: Ident

The name of the method as initially declared.

docs: Docs

Lines of documentation for the method.

full_path_name: Ident

The name of the FFI function wrapping around the method.

self_param: Option<SelfParam>

The self param of the method, if any.

params: Vec<Param>

All non-self params taken by the method.

return_type: Option<TypeName>

The return type of the method, if any.

lifetime_env: LifetimeEnv

The lifetimes introduced in this method and surrounding impl block.

attrs: Attrs

The list of cfg attributes (if any).

These are strings instead of syn::Attribute or proc_macro2::TokenStream because those types are not PartialEq, Hash, Serialize, etc.

Implementations

impl Method

pub fn from_syn( m: &ImplItemFn, self_path_type: PathType, impl_generics: Option<&Generics>, impl_attrs: &Attrs, ) -> Method

Extracts a Method from an AST node inside an impl.

pub fn borrowed_params(&self) -> BorrowedParams<'_>

Returns the parameters that the output is lifetime-bound to.

Examples

Given the following method:

fn foo<'a, 'b: 'a, 'c>(&'a self, bar: Bar<'b>, baz: Baz<'c>) -> FooBar<'a> { ... }

Then this method would return the &'a self and bar: Bar<'b> params because 'a is in the return type, and 'b must live at least as long as 'a. It wouldn’t include baz: Baz<'c> though, because the return type isn’t bound by 'c in any way.

Panics

This method may panic if TypeName::check_result_type_validity (called by Method::check_validity) doesn’t pass first, since the result type may contain elided lifetimes that we depend on for this method. The validity checks ensure that the return type doesn’t elide any lifetimes, ensuring that this method will produce correct results.

pub fn is_writeable_out(&self) -> bool

Checks whether the method qualifies for special writeable handling. To qualify, a method must:

• not return any value
• have the last argument be an &mut diplomat_runtime::DiplomatWriteable

Typically, methods of this form will be transformed in the bindings to a method that doesn’t take the writeable as an argument but instead creates one locally and just returns the final string.

pub fn has_writeable_param(&self) -> bool

Checks if any parameters are writeable (regardless of other compatibilities for writeable output)

pub fn docs(&self) -> &Docs

Returns the documentation block

Trait Implementations

impl Clone for Method

fn clone(&self) -> Method

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Method

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

Formats the value using the given formatter.

impl Hash for Method

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Method

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Method

impl StructuralPartialEq for Method