Update rule.adoc

This commit is contained in:
Gyula Sallai 2025-03-26 14:07:09 +01:00 committed by GitHub
parent 2c65238661
commit ed785116ab
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,44 +1,46 @@
FIXME: add a description
// If you want to factorize the description uncomment the following line and create the file.
//include::../description.adoc[]
== Why is this an issue?
Defining an inherent `to_string(&self)` method on a type that also implements the `Display` trait can lead to confusion, as this inherent method will overshadow the `to_string` method automatically provided by the `Display` trait. The inherent method is less versatile, preventing proper use of the `Display` trait's feature.
FIXME: remove the unused optional headers (that are commented out)
//=== What is the potential impact?
== How to fix it
//== How to fix it in FRAMEWORK NAME
=== Code examples
==== Noncompliant code example
[source,rust,diff-id=1,diff-type=noncompliant]
----
FIXME
use std::fmt;
pub struct A;
impl A {
pub fn to_string(&self) -> String {
"I am A".to_string() // Noncompliant: Inherent method shadows `Display::to_string`.
}
}
impl fmt::Display for A {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "I am A, too")
}
}
----
==== Compliant solution
[source,rust,diff-id=1,diff-type=compliant]
----
FIXME
use std::fmt;
pub struct A;
impl fmt::Display for A {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "I am A")
}
}
----
//=== How does this work?
== Resources
=== Documentation
//=== Pitfalls
//=== Going the extra mile
//== Resources
//=== Documentation
//=== Articles & blog posts
//=== Conference presentations
//=== Standards
//=== External coding guidelines
//=== Benchmarks
* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#inherent_to_string_shadow_display