linux-support 0.0.25

Comprehensive Linux support for namespaces, cgroups, processes, scheduling, parsing /proc, parsing /sys, signals, hyper threads, CPUS, NUMA nodes, unusual file descriptors, PCI devices and much, much more
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

// This file is part of file-descriptors. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/file-descriptors/master/COPYRIGHT. No part of file-descriptors, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2018-2019 The developers of file-descriptors. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/file-descriptors/master/COPYRIGHT.


/// An inotify_event.
///
/// Is of variable length.
pub struct inotify_event
{
	wd: c_int,

	mask: u32,

	/// `cookie` is a unique integer that connects related events.
	///
	/// Currently this is only used for rename events, and allows the resulting pair of `IN_MOVED_FROM` and `IN_MOVED_TO` events to be connected by the application.
	///
	/// For all other event types, cookie is set to 0.
	cookie: u32,

	/// The `len` field counts all of the bytes in `name`, including the null bytes.
	len: u32,

	/// The name field is present only when an event is returned for a file inside a watched directory; it identifies the file pathname relative to the watched directory.
	///
	/// This pathname is null-terminated, and may include further null bytes ('\0') to align subsequent reads to a suitable address boundary.
	name: [c_char; inotify_event::NAME_MAX + 1],
}

impl inotify_event
{
	/// Defined in `limits.h`.
	const NAME_MAX: usize = 255;

	#[inline(always)]
	pub(crate) fn unpopulated() -> Self
	{
		Self
		{
			wd: unsafe_uninitialized(),
			mask: unsafe_uninitialized(),
			cookie: 0,
			len: 0,
			name: unsafe_zeroed(),
		}
	}

	/// Underlying watch descriptor.
	///
	/// `-1` if invalid.
	#[inline(always)]
	pub fn watch_descriptor(&self) -> i32
	{
		self.wd
	}

	/// Underlying watch descriptor is the same as `inotify_watch_descriptor`.
	#[inline(always)]
	pub fn watch_descriptor_is(&self, inotify_watch_descriptor: &InotifyWatchDescriptor) -> bool
	{
		inotify_watch_descriptor.is(self.wd)
	}

	/// Event flags.
	#[inline(always)]
	pub fn flags(&self) -> InotifyEventFlags
	{
		unsafe { transmute(self.mask) }
	}

	/// This is only used for rename events.
	///
	/// It allows the resulting pair of `MovedFrom` and `MovedTo` events to be connected.
	#[inline(always)]
	pub fn cookie(&self) -> u32
	{
		self.cookie
	}

	/// This is only present when an event is returned for a file inside a watched directory.
	#[inline(always)]
	pub fn pathname_relative_to_watch_directory(&self) -> Option<&CStr>
	{
		if self.len == 0
		{
			None
		}
		else
		{
			Some(unsafe { CStr::from_ptr(self.name.as_ptr()) })
		}
	}
}