Replace ConnectionError in public API with io::Error

[thomaseizinger]

Draft until #134 is merged.

Extracted out of libp2p/rust-libp2p#2648.

[mxinden]

@thomaseizinger mind resolving the conflicts here?

[thomaseizinger]

@thomaseizinger mind resolving the conflicts here?

Done! Was just a question of dropping the first commit :)

[mxinden]

I think my suggestion on libp2p/rust-libp2p#2648 was confusing. I meant to suggest to upstream Into<io::Error> for ConnectionError to rust-yamux, not to get rid of ConnectionError on the public interface?

What is the benefit of removing the specific ConnectionError enum in favor of the generic io::Error?

[thomaseizinger]

I think my suggestion on libp2p/rust-libp2p#2648 was confusing. I meant to suggest to upstream Into<io::Error> for ConnectionError to rust-yamux, not to get rid of ConnectionError on the public interface?

What is the benefit of removing the specific ConnectionError enum in favor of the generic io::Error?

One could argue for a smaller and thus simpler public API but I indeed misunderstood your suggestion :)

Happy to also only introduce the mapping function.

[mxinden]

One could argue for a smaller and thus simpler public API

I would argue ConnectionError makes better use of Rust's great type system.

[thomaseizinger]

One could argue for a smaller and thus simpler public API

I would argue ConnectionError makes better use of Rust's great type system.

It does!

I did also perceive its presence as a bit of an annoyance because we don't recover from any of the enumerated errors. So whilst better use of the type system in theory, it does also create boilerplate.

I don't mind either way.

[mxinden]

I did also perceive its presence as a bit of an annoyance because we don't recover from any of the enumerated errors. So whilst better use of the type system in theory, it does also create boilerplate.

I think we should assume rust-yamux to not be used by libp2p only. In other words, while libp2p might not make use of it, others might.

Also while we don't make use of it today in libp2p, we might at some point. Loosing the details through io::Error would be a bummer.

[thomaseizinger]

I did also perceive its presence as a bit of an annoyance because we don't recover from any of the enumerated errors. So whilst better use of the type system in theory, it does also create boilerplate.

I think we should assume rust-yamux to not be used by libp2p only. In other words, while libp2p might not make use of it, others might.

Also while we don't make use of it today in libp2p, we might at some point. Loosing the details through io::Error would be a bummer.

Technically, it is not lost as seen by one of the tests where we recover the inner error, it is just less convenient to access.

Will change back to expose ConnectionError again.

[thomaseizinger]

Closed in favor of #136.