diff --git a/changelog/2476.changed.md b/changelog/2476.changed.md new file mode 100644 index 0000000000..f1151f0680 --- /dev/null +++ b/changelog/2476.changed.md @@ -0,0 +1 @@ +Rename Flags `EventFlag` to `EvFlags`, and `MemFdCreateFlag` to `MFdFlags` diff --git a/src/sys/event.rs b/src/sys/event.rs index b294d27c70..ce3d558312 100644 --- a/src/sys/event.rs +++ b/src/sys/event.rs @@ -173,7 +173,7 @@ libc_bitflags! { /// Event flags. See the man page for details. // There's no useful documentation we can write for the individual flags // that wouldn't simply be repeating the man page. - pub struct EventFlag: type_of_event_flag { + pub struct EvFlags: type_of_event_flag { #[allow(missing_docs)] EV_ADD; #[allow(missing_docs)] @@ -216,6 +216,10 @@ libc_bitflags! { } } +#[deprecated(since = "0.30.0", note = "Use `EvFlags instead`")] +/// The deprecated EventFlag type alias +pub type EventFlag = EvFlags; + libc_bitflags!( /// Filter-specific flags. See the man page for details. // There's no useful documentation we can write for the individual flags @@ -347,7 +351,7 @@ impl KEvent { pub fn new( ident: uintptr_t, filter: EventFilter, - flags: EventFlag, + flags: EvFlags, fflags: FilterFlag, data: intptr_t, udata: intptr_t, @@ -382,8 +386,8 @@ impl KEvent { /// Flags control what the kernel will do when this event is added with /// [`Kqueue::kevent`]. - pub fn flags(&self) -> EventFlag { - EventFlag::from_bits(self.kevent.flags).unwrap() + pub fn flags(&self) -> EvFlags { + EvFlags::from_bits(self.kevent.flags).unwrap() } /// Filter-specific flags. @@ -443,7 +447,7 @@ pub fn ev_set( ev: &mut KEvent, ident: usize, filter: EventFilter, - flags: EventFlag, + flags: EvFlags, fflags: FilterFlag, udata: intptr_t, ) { diff --git a/src/sys/memfd.rs b/src/sys/memfd.rs index 02afdfb7c8..a652ce4984 100644 --- a/src/sys/memfd.rs +++ b/src/sys/memfd.rs @@ -8,7 +8,7 @@ use crate::{NixPath, Result}; libc_bitflags!( /// Options that change the behavior of [`memfd_create`]. - pub struct MemFdCreateFlag: libc::c_uint { + pub struct MFdFlags: libc::c_uint { /// Set the close-on-exec ([`FD_CLOEXEC`]) flag on the new file descriptor. /// /// By default, the new file descriptor is set to remain open across an [`execve`] @@ -74,6 +74,10 @@ libc_bitflags!( } ); +#[deprecated(since = "0.30.0", note = "Use `MFdFlags instead`")] +/// The deprecated MemFdCreateFlag type alias +pub type MemFdCreateFlag = MFdFlags; + /// Creates an anonymous file that lives in memory, and return a file-descriptor to it. /// /// The file behaves like a regular file, and so can be modified, truncated, memory-mapped, and so on. @@ -85,7 +89,7 @@ libc_bitflags!( #[inline] // Delays codegen, preventing linker errors with dylibs and --no-allow-shlib-undefined pub fn memfd_create( name: &P, - flags: MemFdCreateFlag, + flags: MFdFlags, ) -> Result { let res = name.with_nix_path(|cstr| { unsafe { diff --git a/src/sys/signal.rs b/src/sys/signal.rs index 7304b973bb..76495a31aa 100644 --- a/src/sys/signal.rs +++ b/src/sys/signal.rs @@ -1144,7 +1144,7 @@ pub enum SigevNotify<'fd> { /// Will be contained in the kevent's `udata` field. udata: libc::intptr_t, /// Flags that will be set on the delivered event. See `kevent(2)`. - flags: crate::sys::event::EventFlag + flags: crate::sys::event::EvFlags }, /// Notify by delivering a signal to a thread. #[cfg(any( diff --git a/test/sys/test_event.rs b/test/sys/test_event.rs index a10b1e5d12..43dc08ffb7 100644 --- a/test/sys/test_event.rs +++ b/test/sys/test_event.rs @@ -1,5 +1,5 @@ use libc::intptr_t; -use nix::sys::event::{EventFilter, EventFlag, FilterFlag, KEvent}; +use nix::sys::event::{EvFlags, EventFilter, FilterFlag, KEvent}; #[test] fn test_struct_kevent() { @@ -11,7 +11,7 @@ fn test_struct_kevent() { let actual = KEvent::new( 0xdead_beef, EventFilter::EVFILT_READ, - EventFlag::EV_ONESHOT | EventFlag::EV_ADD, + EvFlags::EV_ONESHOT | EvFlags::EV_ADD, FilterFlag::NOTE_CHILD | FilterFlag::NOTE_EXIT, data, udata, @@ -32,7 +32,7 @@ fn test_kevent_filter() { let actual = KEvent::new( 0xdead_beef, EventFilter::EVFILT_READ, - EventFlag::EV_ONESHOT | EventFlag::EV_ADD, + EvFlags::EV_ONESHOT | EvFlags::EV_ADD, FilterFlag::NOTE_CHILD | FilterFlag::NOTE_EXIT, 0x1337, udata, diff --git a/test/sys/test_memfd.rs b/test/sys/test_memfd.rs index a062e69a48..4b3047972f 100644 --- a/test/sys/test_memfd.rs +++ b/test/sys/test_memfd.rs @@ -1,14 +1,13 @@ #[test] fn test_memfd_create() { use nix::sys::memfd::memfd_create; - use nix::sys::memfd::MemFdCreateFlag; + use nix::sys::memfd::MFdFlags; use nix::unistd::lseek; use nix::unistd::read; use nix::unistd::{write, Whence}; let fd = - memfd_create("test_memfd_create_name", MemFdCreateFlag::MFD_CLOEXEC) - .unwrap(); + memfd_create("test_memfd_create_name", MFdFlags::MFD_CLOEXEC).unwrap(); let contents = b"hello"; assert_eq!(write(&fd, contents).unwrap(), 5);