Struct BorrowedParams

#[non_exhaustive]
pub struct BorrowedParams<'a>(pub Option<&'a SelfParam>, pub Vec<(&'a Param, LifetimeKind)>);

Parameters in a method that might be borrowed in the return type.

Tuple 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.

0: Option<&'a SelfParam>

1: Vec<(&'a Param, LifetimeKind)>

Implementations

impl BorrowedParams<'_>

pub fn return_names<'a>( &'a self, self_name: &'a Ident, ) -> impl Iterator<Item = &'a Ident>

Returns an Iterator through the names of the parameters that are borrowed for the lifetime of the return value, accepting an Ident that the self param will be called if present.

pub fn static_names(&self) -> impl Iterator<Item = &Ident>

Returns an Iterator through the names of the parameters that are borrowed for a static lifetime.

pub fn contains(&self, param_name: &Ident) -> bool

Returns true if a provided param name is included in the borrowed params, otherwise false.

This method doesn’t check the self parameter. Use BorrowedParams::borrows_self instead.

pub fn is_empty(&self) -> bool

Returns true if there are no borrowed parameters, otherwise false.

pub fn borrows_self(&self) -> bool

Returns true if the self param is borrowed, otherwise false.

pub fn borrows_params(&self) -> bool

Returns true if there are any borrowed params, otherwise false.

pub fn len(&self) -> usize

Returns the number of borrowed params.

Trait Implementations

impl<'a> Debug for BorrowedParams<'a>

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

Formats the value using the given formatter.

impl<'a> Default for BorrowedParams<'a>

fn default() -> BorrowedParams<'a>

Returns the “default value” for a type.