Skip to content

Remove Socket::(set_)header_included #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 27, 2025
Merged

Remove Socket::(set_)header_included #547

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6e9681
Remove Socket::(set_)header_included
Thomasdezeeuw Jan 25, 2025
0f55e02
Fix doc links
Thomasdezeeuw Jan 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 4 additions & 29 deletions src/socket.rs
View file
Open in desktop
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
Loading