Skip to content

Commit

Permalink
deprecation(iroh)!: remove deprecated type aliases (#2467)
Browse files Browse the repository at this point in the history
## Description

Remove type aliases for the mem and quic node types that are no longer
necessary due to boxing of the rpc channel.

Also document reexports

## Breaking Changes

- iroh: remove client::MemIroh
- iroh: remove client::QuicIroh
- iroh: remove client::MemDoc
- iroh: remove client::QuicDoc

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->

## Change checklist

- [x] Self-review.
- [x] ~~Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.~~
- [x] ~~Tests if relevant.~~
- [x] All breaking changes documented.
  • Loading branch information
rklaehn authored Jul 19, 2024
1 parent c0fa1f4 commit 0102b05
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 0 additions & 8 deletions iroh/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,8 @@ pub use crate::rpc_protocol::RpcService;

mod quic;

#[deprecated]
pub use self::docs::Doc as MemDoc;
#[deprecated]
pub use self::docs::Doc as QuicDoc;
pub use self::docs::Doc;
pub use self::node::NodeStatus;
#[deprecated]
pub use self::Iroh as MemIroh;
#[deprecated]
pub use self::Iroh as QuicIroh;

pub(crate) use self::quic::{connect_raw as quic_connect_raw, RPC_ALPN};

Expand Down
8 changes: 8 additions & 0 deletions iroh/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@
//! **Important**: the protocol to a remote node is not stable and will
//! frequently change. So the client and server must be running the same version of iroh.
//!
//! ## Reexports
//!
//! The iroh crate re-exports the following crates:
//! - [iroh_base](iroh_base) as [`base`]
//! - [iroh_blobs](iroh_blobs) as [`blobs`]
//! - [iroh_docs](iroh_docs) as [`docs`]
//! - [iroh_net](iroh_net) as [`net`]
//!
//! ## Feature Flags
//!
//! - `metrics`: Enable metrics collection. Enabled by default.
Expand Down

0 comments on commit 0102b05

Please sign in to comment.