diff --git a/changelog.md b/changelog.md index 607cee36..6d621d59 100644 --- a/changelog.md +++ b/changelog.md @@ -17,7 +17,8 @@ - \[lib\]\[deprecated\] `ReceiveRequest.filename` is deprecated and replaced by `ReceiveRequest.file_name(..)` - \[lib\]\[deprecated\] `ReceiveRequest.filesize` is deprecated and replaced by `ReceiveRequest.file_size(..)` - \[lib\]\[deprecated\] `Wormhole` public struct fields. Use the provided accessor methods instead. -- \[lib\]\[deprecated\] removed `transit::log_transit_connection` and implemented `Display` on `TransitInfo` instead. +- \[lib\]\[deprecated\] `transit::log_transit_connection` and implemented `Display` on `TransitInfo` instead. +- \[lib\]\[deprecated\] `transfer::PeerMessage` will be removed in the future with no planned public replacement. ## Version 0.6.1 diff --git a/src/core.rs b/src/core.rs index 77adda1f..cdcbc12d 100644 --- a/src/core.rs +++ b/src/core.rs @@ -169,8 +169,9 @@ impl MailboxConnection { /// /// * `config`: Application configuration /// * `code`: The `Code` required to authorize to connect to an existing mailbox. - /// * `allocate`: `true`: Allocates a `Nameplate` if it does not exist. - /// `false`: The call fails with a `WormholeError::UnclaimedNameplate` when the `Nameplate` does not exist. + /// * `allocate`: + /// - `true`: Allocates a `Nameplate` if it does not exist. + /// - `false`: The call fails with a `WormholeError::UnclaimedNameplate` when the `Nameplate` does not exist. /// /// # Examples /// @@ -275,7 +276,7 @@ impl Wormhole { */ #[deprecated( since = "0.7.0", - note = "please use 'MailboxConnection::create(...) and Wormhole::connect(mailbox_connection)' instead" + note = "please use 'MailboxConnection::create(..) and Wormhole::connect(mailbox_connection)' instead" )] #[allow(deprecated)] pub async fn connect_without_code( @@ -303,7 +304,7 @@ impl Wormhole { */ #[deprecated( since = "0.7.0", - note = "please use 'MailboxConnection::connect(...) and Wormhole::connect(mailbox_connection)' instead" + note = "please use 'MailboxConnection::connect(..) and Wormhole::connect(mailbox_connection)' instead" )] #[allow(deprecated)] pub async fn connect_with_code( diff --git a/src/transfer.rs b/src/transfer.rs index c5d4758b..35a3f7d8 100644 --- a/src/transfer.rs +++ b/src/transfer.rs @@ -8,6 +8,8 @@ //! At its core, "peer messages" are exchanged over an established wormhole connection with the other side. //! They are used to set up a [transit] portal and to exchange a file offer/accept. Then, the file is transmitted over the transit relay. +#![allow(deprecated)] + use futures::{AsyncRead, AsyncSeek, AsyncWrite}; use serde_derive::{Deserialize, Serialize}; #[cfg(test)] @@ -47,7 +49,7 @@ const APPID_RAW: &str = "lothar.com/wormhole/text-or-file-xfer"; /// The App ID associated with this protocol. pub const APPID: AppID = AppID(Cow::Borrowed(APPID_RAW)); -/// An [`crate::AppConfig`] with sane defaults for this protocol. +/// An [`crate::AppConfig`] with default parameters for the file transfer protocol. /// /// You **must not** change `id` and `rendezvous_url` to be interoperable. /// The `app_version` can be adjusted if you want to disable some features. @@ -211,6 +213,10 @@ impl AsyncWriteSeek for T where T: AsyncWrite + AsyncSeek {} #[derive(Deserialize, Serialize, derive_more::Display, Debug, Clone)] #[serde(rename_all = "kebab-case")] #[non_exhaustive] +#[deprecated( + since = "0.7.0", + note = "This will be a private type in the future. Open an issue if you require access to protocol intrinsics in the future" +)] pub enum PeerMessage { /* V1 */ #[display(fmt = "transit")]