Skip to content

Commit

Permalink
changelog: Update deprecation notices
Browse files Browse the repository at this point in the history
  • Loading branch information
felinira committed Jul 15, 2024
1 parent 09c8979 commit 45c069e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
3 changes: 2 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 7 additions & 1 deletion src/transfer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -211,6 +213,10 @@ impl<T> 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")]
Expand Down

0 comments on commit 45c069e

Please sign in to comment.