Skip to content

Commit

Permalink
Remove Socket::(set_)header_included (#547)
Browse files Browse the repository at this point in the history
Replaced by Socket::(set_)header_included_v4.
  • Loading branch information
Thomasdezeeuw authored Jan 27, 2025
1 parent f0ed438 commit 25337f1
Showing 1 changed file with 4 additions and 29 deletions.
33 changes: 4 additions & 29 deletions src/socket.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1139,21 +1139,11 @@ const fn into_linger(duration: Option<Duration>) -> sys::linger {
/// * Linux: <https://man7.org/linux/man-pages/man7/ip.7.html>
/// * Windows: <https://docs.microsoft.com/en-us/windows/win32/winsock/ipproto-ip-socket-options>
impl Socket {
/// This method is deprecated, use [`crate::Socket::header_included_v4`].
#[cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf"))))]
#[cfg_attr(
docsrs,
doc(cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf")))))
)]
#[deprecated = "Use `Socket::header_included_v4` instead"]
pub fn header_included(&self) -> io::Result<bool> {
self.header_included_v4()
}
/// Get the value of the `IP_HDRINCL` option on this socket.
///
/// For more information about this option, see [`set_header_included`].
/// For more information about this option, see [`set_header_included_v4`].
///
/// [`set_header_included`]: Socket::set_header_included
/// [`set_header_included_v4`]: Socket::set_header_included_v4
#[cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf"))))]
#[cfg_attr(
docsrs,
Expand All @@ -1166,21 +1156,6 @@ impl Socket {
}
}

/// This method is deprecated, use [`crate::Socket::set_header_included_v4`].
#[cfg_attr(
any(target_os = "fuchsia", target_os = "illumos", target_os = "solaris"),
allow(rustdoc::broken_intra_doc_links)
)]
#[cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf"))))]
#[cfg_attr(
docsrs,
doc(cfg(all(feature = "all", not(any(target_os = "redox", target_os = "espidf")))))
)]
#[deprecated = "Use `Socket::set_header_included_v4` instead"]
pub fn set_header_included(&self, included: bool) -> io::Result<()> {
self.set_header_included_v4(included)
}

/// Set the value of the `IP_HDRINCL` option on this socket.
///
/// If enabled, the user supplies an IP header in front of the user data.
Expand Down Expand Up @@ -1679,9 +1654,9 @@ impl Socket {
impl Socket {
/// Get the value of the `IP_HDRINCL` option on this socket.
///
/// For more information about this option, see [`set_header_included`].
/// For more information about this option, see [`set_header_included_v6`].
///
/// [`set_header_included`]: Socket::set_header_included
/// [`set_header_included_v6`]: Socket::set_header_included_v6
#[cfg(all(
feature = "all",
not(any(
Expand Down

0 comments on commit 25337f1

Please sign in to comment.