Enum clippy_utils::sugg::Sugg

pub enum Sugg<'a> {
    NonParen(Cow<'a, str>),
    MaybeParen(Cow<'a, str>),
    BinOp(AssocOp, Cow<'a, str>, Cow<'a, str>),
}

A helper type to build suggestion correctly handling parentheses.

Variants

NonParen(Cow<'a, str>)

An expression that never needs parentheses such as 1337 or [0; 42].

MaybeParen(Cow<'a, str>)

An expression that does not fit in other variants.

BinOp(AssocOp, Cow<'a, str>, Cow<'a, str>)

A binary operator expression, including as-casts and explicit type coercion.

Implementations

impl<'a> Sugg<'a>

pub fn hir_opt(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Self>

Prepare a suggestion from an expression.

pub fn hir(cx: &LateContext<'_>, expr: &Expr<'_>, default: &'a str) -> Self

Convenience function around hir_opt for suggestions with a default text.

pub fn hir_with_applicability(
    cx: &LateContext<'_>,
    expr: &Expr<'_>,
    default: &'a str,
    applicability: &mut Applicability
) -> Self

Same as hir, but it adapts the applicability level by following rules:

• Applicability level Unspecified will never be changed.
• If the span is inside a macro, change the applicability level to MaybeIncorrect.
• If the default value is used and the applicability level is MachineApplicable, change it to HasPlaceholders

pub fn hir_with_macro_callsite(
    cx: &LateContext<'_>,
    expr: &Expr<'_>,
    default: &'a str
) -> Self

Same as hir, but will use the pre expansion span if the expr was in a macro.

pub fn hir_with_context(
    cx: &LateContext<'_>,
    expr: &Expr<'_>,
    ctxt: SyntaxContext,
    default: &'a str,
    applicability: &mut Applicability
) -> Self

Same as hir, but first walks the span up to the given context. This will result in the macro call, rather then the expansion, if the span is from a child context. If the span is not from a child context, it will be used directly instead.

e.g. Given the expression &vec![], getting a snippet from the span for vec![] as a HIR node would result in box []. If given the context of the address of expression, this function will correctly get a snippet of vec![].

fn hir_from_snippet(
    expr: &Expr<'_>,
    get_snippet: impl Fn(Span) -> Cow<'a, str>
) -> Self

Generate a suggestion for an expression with the given snippet. This is used by the hir_* function variants of Sugg, since these use different snippet functions.

pub fn ast(cx: &EarlyContext<'_>, expr: &Expr, default: &'a str) -> Self

Prepare a suggestion from an expression.

pub fn and(self, rhs: &Self) -> Sugg<'static>

Convenience method to create the <lhs> && <rhs> suggestion.

pub fn bit_and(self, rhs: &Self) -> Sugg<'static>

Convenience method to create the <lhs> & <rhs> suggestion.

pub fn as_ty<R: Display>(self, rhs: R) -> Sugg<'static>

Convenience method to create the <lhs> as <rhs> suggestion.

pub fn addr(self) -> Sugg<'static>

Convenience method to create the &<expr> suggestion.

pub fn mut_addr(self) -> Sugg<'static>

Convenience method to create the &mut <expr> suggestion.

pub fn deref(self) -> Sugg<'static>

Convenience method to create the *<expr> suggestion.

pub fn addr_deref(self) -> Sugg<'static>

Convenience method to create the &*<expr> suggestion. Currently this is needed because sugg.deref().addr() produces an unnecessary set of parentheses around the deref.

pub fn mut_addr_deref(self) -> Sugg<'static>

Convenience method to create the &mut *<expr> suggestion. Currently this is needed because sugg.deref().mut_addr() produces an unnecessary set of parentheses around the deref.

pub fn make_return(self) -> Sugg<'static>

Convenience method to transform suggestion into a return call

pub fn blockify(self) -> Sugg<'static>

Convenience method to transform suggestion into a block where the suggestion is a trailing expression

pub fn asyncify(self) -> Sugg<'static>

Convenience method to prefix the expression with the async keyword. Can be used after blockify to create an async block.

pub fn range(self, end: &Self, limit: RangeLimits) -> Sugg<'static>

Convenience method to create the <lhs>..<rhs> or <lhs>...<rhs> suggestion.

pub fn maybe_par(self) -> Self

Adds parentheses to any expression that might need them. Suitable to the self argument of a method call (e.g., to build bar.foo() or (1 + 2).foo()).

Trait Implementations

impl Add<&Sugg<'_>> for &Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the + operator.

fn add(self, rhs: &Sugg<'_>) -> Sugg<'static>

Performs the + operation.

impl Add<&Sugg<'_>> for Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the + operator.

fn add(self, other: &Sugg<'_>) -> Sugg<'static>

Performs the + operation.

impl Add<Sugg<'_>> for &Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the + operator.

fn add(self, other: Sugg<'_>) -> Sugg<'static>

Performs the + operation.

impl Add<Sugg<'_>> for Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the + operator.

fn add(self, other: Sugg<'_>) -> Sugg<'static>

Performs the + operation.

impl<'a> Clone for Sugg<'a>

fn clone(&self) -> Sugg<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Sugg<'_>

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

Formats the value using the given formatter.

impl Neg for Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the - operator.

fn neg(self) -> Sugg<'static>

Performs the unary - operation.

impl<'a> Not for Sugg<'a>

type Output = Sugg<'a>

The resulting type after applying the ! operator.

fn not(self) -> Sugg<'a>

Performs the unary ! operation.

impl<'a> PartialEq<Sugg<'a>> for Sugg<'a>

fn eq(&self, other: &Sugg<'a>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<&Sugg<'_>> for &Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the - operator.

fn sub(self, rhs: &Sugg<'_>) -> Sugg<'static>

Performs the - operation.

impl Sub<&Sugg<'_>> for Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the - operator.

fn sub(self, other: &Sugg<'_>) -> Sugg<'static>

Performs the - operation.

impl Sub<Sugg<'_>> for &Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the - operator.

fn sub(self, other: Sugg<'_>) -> Sugg<'static>

Performs the - operation.

impl Sub<Sugg<'_>> for Sugg<'_>

type Output = Sugg<'static>

The resulting type after applying the - operator.

fn sub(self, other: Sugg<'_>) -> Sugg<'static>

Performs the - operation.

impl<'a> StructuralPartialEq for Sugg<'a>

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

Size for each variant:

• NonParen: 31 bytes
• MaybeParen: 31 bytes
• BinOp: 55 bytes