Merge rust-bitcoin/rust-bitcoin#2284: policy: Add section on returning `Self`

472da02c58 policy: Add section on returning Self (Tobin C. Harding)

Pull request description:

  Returning `Self` instead of the actual type makes refactoring easier, especially for error enums.

ACKs for top commit:
  Kixunil:
    ACK 472da02c58
  apoelstra:
    ACK 472da02c58

Tree-SHA512: 22c74ed02b06907a3e2d79e82620e90e5cad2bd64322fc87ce01640c1ca51907c43329211952c62776834bbdce936f312f82ab166e85a8559614cfa25c0db708
This commit is contained in:
Andrew Poelstra 2023-12-15 15:00:27 +00:00
commit 37a6b48933
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 43 additions and 0 deletions

View File

@ -255,6 +255,49 @@ pub use {
}
```
#### Return `Self`
Use `Self` as the return type instead of naming the type. When constructing the return value use
`Self` or the type name, whichever you prefer.
```rust
/// A counter that is always smaller than 100.
pub struct Counter(u32);
impl Counter {
/// Constructs a new `Counter`.
pub fn new() -> Self { Self(0) }
/// Returns a counter if it is possible to create one from x.
pub fn maybe(x: u32) -> Option<Self> {
match x {
x if x >= 100 => None,
c => Some(Counter(c)),
}
}
}
impl TryFrom<u32> for Counter {
type Error = TooBigError;
fn try_from(x: u32) -> Result<Self, Self::Error> {
if x >= 100 {
return Err(TooBigError);
}
Ok(Counter(x))
}
}
```
When constructing the return value for error enums use `Self`.
```rust
impl From<foo::Error> for LongDescriptiveError {
fn from(e: foo::Error) -> Self { Self::Foo(e) }
}
```
#### Errors
Return as much context as possible with errors e.g., if an error was encountered parsing a string