Struct rustdoc::clean::types::FnDecl

pub(crate) struct FnDecl {
    pub(crate) inputs: Arguments,
    pub(crate) output: FnRetTy,
    pub(crate) c_variadic: bool,
    pub(crate) attrs: Attributes,
}

Fields

inputs: Arguments

output: FnRetTy

c_variadic: bool

attrs: Attributes

Implementations

impl FnDecl

pub(crate) fn self_type(&self) -> Option<SelfTy>

pub(crate) fn sugared_async_return_type(&self) -> FnRetTy

Returns the sugared return type for an async function.

For example, if the return type is impl std::future::Future<Output = i32>, this function will return i32.

Panics

This function will panic if the return type does not match the expected sugaring for async functions.

impl FnDecl

pub(crate) fn print(&self) -> impl Display + '_

Trait Implementations

impl<'a, A: Copy> Clean<FnDecl> for (&'a FnDecl<'a>, A) where
    (&'a [Ty<'a>], A): Clean<Arguments>, 

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> FnDecl

impl<'tcx> Clean<FnDecl> for (DefId, PolyFnSig<'tcx>)

pub(crate) fn clean(&self, cx: &DocContext<'_>) -> FnDecl

impl Clone for FnDecl

pub fn clone(&self) -> FnDecl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FnDecl

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

Formats the value using the given formatter.

impl Eq for FnDecl

impl Hash for FnDecl

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<FnDecl> for FnDecl

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

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

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

This method tests for !=.

impl StructuralEq for FnDecl

impl StructuralPartialEq for FnDecl