Struct diplomat_core::ast::Method

source · [−]

pub struct Method {
    pub name: String,
    pub docs: Docs,
    pub full_path_name: String,
    pub self_param: Option<Param>,
    pub params: Vec<Param>,
    pub return_type: Option<TypeName>,
}

Expand description

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

name: String

The name of the method as initially declared.

docs: Docs

Lines of documentation for the method.

full_path_name: String

The name of the FFI function wrapping around the method.

self_param: Option<Param>

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.

Implementations

impl Method

pub fn from_syn(m: &ImplItemMethod, self_path: &Path) -> Method

Extracts a Method from an AST node inside an impl.

pub fn check_validity<'a>(
    &'a self,
    in_path: &Path,
    env: &Env,
    errors: &mut Vec<ValidityError>
)

Performs type-specific validity checks (see TypeName::check_validity())

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)

Trait Implementations

impl Clone for Method

fn clone(&self) -> Method

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Method

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Method

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Hash for Method

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<Method> for Method

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

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

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

This method tests for !=.

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. Read more

impl Eq for Method

impl StructuralEq for Method

impl StructuralPartialEq for Method

Auto Trait Implementations

impl RefUnwindSafe for Method

impl Send for Method

impl Sync for Method

impl Unpin for Method

impl UnwindSafe for Method

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,