Struct rustdoc::clean::types::FnDecl

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

Fields

inputs: Arguments

output: FnRetTy

c_variadic: bool

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<'b, 'a: 'b, 'tcx: 'a>(
    &'a self,
    cx: &'a Context<'tcx>
) -> impl Display + 'b + Captures<'tcx>

pub(crate) fn full_print<'a, 'tcx: 'a>(
    &'a self,
    header_len: usize,
    indent: usize,
    asyncness: IsAsync,
    cx: &'a Context<'tcx>
) -> impl Display + 'a + Captures<'tcx>

• header_len: The length of the function header and name. In other words, the number of characters in the function declaration up to but not including the parentheses.
  Used to determine line-wrapping.
• indent: The number of spaces to indent each successive line with, if line-wrapping is necessary.
• asyncness: Whether the function is async or not.

fn inner_full_print(
    &self,
    header_len: usize,
    indent: usize,
    asyncness: IsAsync,
    f: &mut Formatter<'_>,
    cx: &Context<'_>
) -> Result

Trait Implementations

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

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

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

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

impl Clone for FnDecl

fn clone(&self) -> FnDecl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FnDecl

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

Formats the value using the given formatter.

impl FromWithTcx<FnDecl> for FnDecl

fn from_tcx(decl: FnDecl, tcx: TyCtxt<'_>) -> Self

impl Hash for FnDecl

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<FnDecl> for FnDecl

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

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

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

This method tests for !=.

impl Eq for FnDecl

impl StructuralEq for FnDecl

impl StructuralPartialEq for FnDecl

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: 104 bytes