Import 'inotify-sys' crate
Request Document: go/android-rust-importing-crates
For CL Reviewers: go/android3p#cl-review
For Build Team: go/ab-third-party-imports
Bug: 374130642
Test: m libinotify_sys
Change-Id: I581e3afdd8193e0b10d0574b08e164ea75f4aba9
diff --git a/Android.bp b/Android.bp
new file mode 100644
index 0000000..de988b5
--- /dev/null
+++ b/Android.bp
@@ -0,0 +1,31 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_inotify-sys_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_inotify-sys_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-ISC"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libinotify_sys",
+ host_supported: true,
+ crate_name: "inotify_sys",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.3",
+ crate_root: "src/lib.rs",
+ edition: "2015",
+ rustlibs: ["liblibc"],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..bdcd2c5
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,7 @@
+<a name="v0.1.3"></a>
+### v0.1.3 (2018-07-26)
+
+
+#### Bug Fixes
+
+* Use platform-specific constants from libc ([b363dff1](b363dff1))
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..2c2e949
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,69 @@
+# Contributing to inotify-rs
+
+Thank you for considering to work on inotify-rs. We're always happy to see outside contributions, small or large.
+
+You probably found this document in the repository of either the [inotify] or [inotify-sys] crate. Both are part of the same project, so this guide is valid for both (in fact, the documents in either repository should be identical).
+
+## Opening issues
+
+If you found a problem with inotify-rs, please open an issue to let us know. If you're not sure whether you found a problem or not, just open an issue anyway. We'd rather close a few invalid issues than miss real problems.
+
+Issues are tracked on GitHub, in the repository for the respective crate:
+- [Open an inotify issue](https://github.com/inotify-rs/inotify/issues/new)
+- [Open an inotify-sys issue](https://github.com/inotify-rs/inotify-sys/issues/new)
+
+If you're unsure where to open your issue, just open it in the [inotify] repository.
+
+## Contributing changes
+
+If you want to make a change to the inotify-rs code, please open a pull request on the respective repository. The best way to open a pull request is usually to just push a branch to your fork, and click the button that should appear near the top of your fork's GitHub page.
+
+If you're having any problems with completing your change, feel free to open a pull request anyway and ask any questions there. We're happy to help with getting changes across the finish line.
+
+## Commit guidelines
+
+We use [clog] to generate a changelog for each release. This is done automatically, using the commit messages as a data source. Therefore it is very imporant to write clear commit messages and tag them in a way that the tool can understand.
+
+The rest of this section explains the rules for commit messages. Please don't be put off, if this seems overwhelming. As always, if you're unsure about anything, just send a pull request. [GitCop] and the reviewer will happily point out any problems.
+
+Before we go into the rules, here's an example of a commit message:
+```
+feat: Implement a feature
+
+This is the commit message body. It is optional and might consist of
+multiple paragraphs.
+
+Here's the message body's second paragraph. The next paragraph is going
+to automatically close an issue, once the commit is merged into the
+repository.
+
+Closes #123456.
+```
+
+First, let's start with the first line, the header. It's the most important part of the commit, as it's used by [clog] to generate the changelog. For that reason, it's the most heavily regulated part:
+- The header's purpose is to concisely summarize the changes made.
+- It must be **at most 50 characters** long.
+- It should be written in the **imperative voice**, as if you're commanding someone. So, "Add something", as opposed to "Adding something" or "Added something".
+- It must begin with the type of commit, followed by a colon (e.g. "feat:" or "fix:"). The following types can be used:
+ - **feat**: New functionality, or changes (not bug fixes) to existing functionality.
+ - **fix**: Bug fixes
+ - **docs**: Improvements to documentation
+ - **style**: Code formatting, indentation, etc.
+ - **refactor**: Changes to code that don't change what it does. Cleaning up, moving stuff around, etc.
+ - **perf**: Performance improvements
+ - **test**: Changes to test code
+ - **chore**: Custodial work that isn't directly related to the code. Changes to the build system, etc.
+
+These rules apply to the message body:
+- The messages body is optional, but should be added if the header and the commit diff by themselves don't explain why the commit is necessary.
+- It should **provide context** for the commit and **explain its reasoning**. It doesn't need to restate things that are already obvious from the commit diff.
+- Please be mindful of explanations of how the code works. Often, it makes more sense to add such explanations to the code itself, as comments.
+- The length limit for lines in the commit body is **72 characters**.
+- If any issues should be closed once the commit is merged, this can be done automatically by adding something like "Closes #123456" to the commit. Be careful about not doing this accidentally.
+
+That's it! If anything about this document is unclear, feel free to open an issue. If you have questions regarding a pull request that you're working on, just open the pull request and ask your questions there.
+
+[inotify]: https://github.com/inotify-rs/inotify
+[inotify-sys]: https://github.com/inotify-rs/inotify-sys
+[clog]: https://crates.io/crates/clog-cli
+[GitCop]: https://gitcop.com/
\ No newline at end of file
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..47b87d8
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,36 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g. crates.io) dependencies
+#
+# If you believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+name = "inotify-sys"
+version = "0.1.3"
+authors = ["Hanno Braun <[email protected]>"]
+description = "inotify bindings for the Rust programming language"
+documentation = "https://docs.rs/inotify-sys"
+readme = "README.md"
+keywords = ["inotify", "linux"]
+categories = ["external-ffi-bindings", "filesystem"]
+license = "ISC"
+repository = "https://github.com/inotify-rs/inotify-sys"
+[package.metadata.release]
+dev-version-ext = "dev"
+pre-release-commit-message = "chore: Release version {{version}}"
+pro-release-commit-message = "chore: Bump version to {{version}}"
+tag-message = "Version {{version}}"
+tag-prefix = "v"
+[dependencies.libc]
+version = "0.2"
+[badges.maintenance]
+status = "actively-developed"
+
+[badges.travis-ci]
+repository = "inotify-rs/inotify-sys"
diff --git a/Cargo.toml.orig b/Cargo.toml.orig
new file mode 100644
index 0000000..81eaeae
--- /dev/null
+++ b/Cargo.toml.orig
@@ -0,0 +1,27 @@
+[package]
+name = "inotify-sys"
+version = "0.1.3"
+authors = ["Hanno Braun <[email protected]>"]
+
+description = "inotify bindings for the Rust programming language"
+documentation = "https://docs.rs/inotify-sys"
+repository = "https://github.com/inotify-rs/inotify-sys"
+license = "ISC"
+readme = "README.md"
+
+keywords = ["inotify", "linux"]
+categories = ["external-ffi-bindings", "filesystem"]
+
+[badges]
+maintenance = { status = "actively-developed" }
+travis-ci = { repository = "inotify-rs/inotify-sys" }
+
+[dependencies]
+libc = "0.2"
+
+[package.metadata.release]
+pre-release-commit-message = "chore: Release version {{version}}"
+pro-release-commit-message = "chore: Bump version to {{version}}"
+tag-prefix = "v"
+tag-message = "Version {{version}}"
+dev-version-ext = "dev"
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..855ee51
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) Hanno Braun and contributors
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/METADATA b/METADATA
new file mode 100644
index 0000000..f59ae29
--- /dev/null
+++ b/METADATA
@@ -0,0 +1,19 @@
+name: "inotify-sys"
+description:
+ "Low-level inotify bindings for the Rust programming language. This crate's "
+ "main purpose is to serve as the base for inotify-rs, the idiomatic Rust "
+ "wrapper around inotify. Unless you're sure you specifically need this "
+ "crate, please use inotify-rs instead."
+
+third_party {
+homepage: "https://crates.io/crates/inotify-sys"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/inotify-sys/inotify-sys-0.1.3.crate"
+ primary_source: true
+ version: "0.1.3"
+ }
+ version: "0.1.3"
+ last_upgrade_date { year: 2024 month: 11 day: 12 }
+ license_type: NOTICE
+}
diff --git a/MODULE_LICENSE_ISC b/MODULE_LICENSE_ISC
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_ISC
diff --git a/OWNERS b/OWNERS
new file mode 100644
index 0000000..48bea6e
--- /dev/null
+++ b/OWNERS
@@ -0,0 +1,2 @@
+# Bug component: 688011
+include platform/prebuilts/rust:main:/OWNERS
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..97b466b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# inotify-sys [](https://crates.io/crates/inotify-sys) [](https://docs.rs/inotify-sys) [](https://travis-ci.org/inotify-rs/inotify-sys)
+
+Low-level [inotify] bindings for the [Rust programming language]. This crate's main purpose is to serve as the base for [inotify-rs], the idiomatic Rust wrapper around inotify. Unless you're sure you specifically need this crate, please use [inotify-rs] instead.
+
+
+## License
+
+Copyright (c) 2014-2017, Hanno Braun and contributors
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
+
+
+[inotify]: http://en.wikipedia.org/wiki/Inotify
+[Rust programming language]: http://rust-lang.org/
+[inotify-rs]: https://crates.io/crates/inotify
diff --git a/cargo_embargo.json b/cargo_embargo.json
new file mode 100644
index 0000000..cb908d7
--- /dev/null
+++ b/cargo_embargo.json
@@ -0,0 +1,3 @@
+{
+ "run_cargo": false
+}
diff --git a/inotify-sys.sublime-project b/inotify-sys.sublime-project
new file mode 100644
index 0000000..077b3dd
--- /dev/null
+++ b/inotify-sys.sublime-project
@@ -0,0 +1,9 @@
+{
+ "folders":
+ [
+ {
+ "path": ".",
+ "file_exclude_patterns": [ "target/*" ]
+ }
+ ]
+}
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..84924e6
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,713 @@
+#![deny(missing_docs)]
+#![deny(warnings)]
+
+
+//! # inotify bindings for the Rust programming language
+//!
+//! Please note that these are direct, low-level bindings to C functions that
+//! form the inotify C API. Unless you have a specific reason to use this crate,
+//! [inotify-rs], which is an idiomatic wrapper, is a much better choice.
+//!
+//! ## Usage
+//!
+//! In general, inotify usage follows the following pattern:
+//!
+//! 1. Create an inotify instance using [`inotify_init`] or [`inotify_init1`].
+//! 2. Manage watches with [`inotify_add_watch`] and [`inotify_rm_watch`].
+//! 3. Read event using [`read`].
+//! 4. Close the inotify instance using [`close`], once you're done.
+//!
+//! Please refer to the [inotify man page] and the rest of this documentation
+//! for full details.
+//!
+//! [inotify-rs]: https://crates.io/crates/inotify
+//! [`inotify_init`]: fn.inotify_init.html
+//! [`inotify_init1`]: fn.inotify_init1.html
+//! [`inotify_add_watch`]: fn.inotify_add_watch.html
+//! [`inotify_rm_watch`]: fn.inotify_rm_watch.html
+//! [`read`]: fn.read.html
+//! [`close`]: fn.close.html
+//! [inotify man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+
+
+extern crate libc;
+
+
+use libc::{
+ c_char,
+ c_int,
+ uint32_t };
+
+
+/// Set the `FD_CLOEXEC` flag for an inotify instance
+///
+/// Can be passed to [`inotify_init1`] to set the `FD_CLOEXEC` flag for the
+/// inotify instance. This changes the behavior of file descriptor when
+/// [execve(2)]'d. From [fcntl(2)]:
+///
+/// > If the FD_CLOEXEC bit is 0, the file descriptor will
+/// > remain open across an [execve(2)], otherwise it will be
+/// > closed.
+///
+/// See [open(2)] and [fcntl(2)] for details.
+///
+/// [`inotify_init1`]: fn.inotify_init1.html
+/// [execve(2)]: http://man7.org/linux/man-pages/man2/execve.2.html
+/// [open(2)]: http://man7.org/linux/man-pages/man2/open.2.html
+/// [fcntl(2)]: http://man7.org/linux/man-pages/man2/fcntl.2.html
+pub const IN_CLOEXEC: c_int = libc::O_CLOEXEC;
+
+/// Set an inotify instance to non-blocking mode
+///
+/// Can be passed to [`inotify_init1`] to set the `O_NONBLOCK` flag for the
+/// inotify instance.
+///
+/// See [open(2)] for details.
+///
+/// [`inotify_init1`]: fn.inotify_init1.html
+/// [open(2)]: http://man7.org/linux/man-pages/man2/open.2.html
+pub const IN_NONBLOCK: c_int = libc::O_NONBLOCK;
+
+/// Event: File was accessed
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event will be triggered only for files
+/// within the directory.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_ACCESS: uint32_t = 0x00000001;
+
+/// Event: File was modified
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event will be triggered only for files
+/// within the directory.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_MODIFY: uint32_t = 0x00000002;
+
+/// Event: Metadata was changed
+///
+/// This can include e.g.
+///
+/// - permissions, see [chmod(2)];
+/// - timestamps, see [utimensat(2)];
+/// - extended attributes, see [setxattr(2)];
+/// - link count, see [link(2)] and [unlink(2)];
+/// - user/group, see [chown(2)].
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event can be triggered for both for the
+/// directory itself and the files within.
+///
+/// See [man page] for additional details.
+///
+/// [chmod(2)]: http://man7.org/linux/man-pages/man2/chmod.2.html
+/// [utimensat(2)]: http://man7.org/linux/man-pages/man2/utimensat.2.html
+/// [setxattr(2)]: http://man7.org/linux/man-pages/man2/fsetxattr.2.html
+/// [link(2)]: http://man7.org/linux/man-pages/man2/link.2.html
+/// [unlink(2)]: http://man7.org/linux/man-pages/man2/unlink.2.html
+/// [chown(2)]: http://man7.org/linux/man-pages/man2/chown.2.html
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_ATTRIB: uint32_t = 0x00000004;
+
+/// Event: Writable file was closed
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event will be triggered only for files
+/// within the directory.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_CLOSE_WRITE: uint32_t = 0x00000008;
+
+/// Event: Non-writable file or directory was closed
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event can be triggered for both for the
+/// directory itself and the files within.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_CLOSE_NOWRITE: uint32_t = 0x00000010;
+
+/// Event: File or directory was opened
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event can be triggered for both for the
+/// directory itself and the files within.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_OPEN: uint32_t = 0x00000020;
+
+/// Event: File or directory was moved out of watched directory
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event will be triggered only for files
+/// within the directory.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_MOVED_FROM: uint32_t = 0x00000040;
+
+/// Event: File or directory was moved into watched directory
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event will be triggered only for files
+/// within the directory.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_MOVED_TO: uint32_t = 0x00000080;
+
+/// Event: File or directory was created in watched directory
+///
+/// This may also include hard links, symlinks, and UNIX sockets.
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event will be triggered only for files
+/// within the directory.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_CREATE: uint32_t = 0x00000100;
+
+/// Event: File or directory in watched directory was deleted
+///
+/// This may also include hard links, symlinks, and UNIX sockets.
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// When monitoring a directory, this event will be triggered only for files
+/// within the directory.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_DELETE: uint32_t = 0x00000200;
+
+/// Event: Watched file or directory was deleted
+///
+/// This may also occur if the object is moved to another filesystem, since
+/// [mv(1)] in effect copies the file to the other filesystem and then deletes
+/// it from the original.
+///
+/// An IN_IGNORED event will subsequently be generated.
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// See [man page] for additional details.
+///
+/// [mv(1)]: http://man7.org/linux/man-pages/man1/mv.1.html
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_DELETE_SELF: uint32_t = 0x00000400;
+
+/// Event: Watched file or directory was moved
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_MOVE_SELF: uint32_t = 0x00000800;
+
+/// Event: File or directory within watched directory was moved
+///
+/// This is a combination of [`IN_MOVED_FROM`] and [`IN_MOVED_TO`].
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// See [man page] for additional details.
+///
+/// [`IN_MOVED_FROM`]: constant.IN_MOVED_FROM.html
+/// [`IN_MOVED_TO`]: constant.IN_MOVED_TO.html
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_MOVE: uint32_t = (IN_MOVED_FROM | IN_MOVED_TO);
+
+/// Event: File was closed
+///
+/// This is a combination of [`IN_CLOSE_WRITE`] and [`IN_CLOSE_NOWRITE`].
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in this type of event, or it can be used to check (via [`inotify_event`]'s
+/// [`mask`] field) whether an event is of this type.
+///
+/// See [man page] for additional details.
+///
+/// [`IN_CLOSE_WRITE`]: constant.IN_CLOSE_WRITE.html
+/// [`IN_CLOSE_NOWRITE`]: constant.IN_CLOSE_NOWRITE.html
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [`inotify_event`]: struct.inotify_event.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_CLOSE: uint32_t = (IN_CLOSE_WRITE | IN_CLOSE_NOWRITE);
+
+/// Event: Any event occured
+///
+/// This is a combination of all the other event constants:
+///
+/// - [`IN_ACCESS`]
+/// - [`IN_ATTRIB`]
+/// - [`IN_CLOSE_WRITE`]
+/// - [`IN_CLOSE_NOWRITE`]
+/// - [`IN_MODIFY`]
+/// - [`IN_CREATE`]
+/// - [`IN_DELETE`]
+/// - [`IN_DELETE_SELF`]
+/// - [`IN_MODIFY`]
+/// - [`IN_MOVE_SELF`]
+/// - [`IN_MOVED_FROM`]
+/// - [`IN_MOVED_TO`]
+/// - [`IN_OPEN`]
+///
+/// This constant can be passed to [`inotify_add_watch`], to register interest
+/// in any type of event.
+///
+/// See [man page] for additional details.
+///
+/// [`IN_ACCESS`]: constant.IN_ACCESS.html
+/// [`IN_ATTRIB`]: constant.IN_ATTRIB.html
+/// [`IN_CLOSE_WRITE`]: constant.IN_CLOSE_WRITE.html
+/// [`IN_CLOSE_NOWRITE`]: constant.IN_CLOSE_NOWRITE.html
+/// [`IN_MODIFY`]: constant.IN_MODIFY.html
+/// [`IN_CREATE`]: constant.IN_CREATE.html
+/// [`IN_DELETE`]: constant.IN_DELETE.html
+/// [`IN_DELETE_SELF`]: constant.IN_DELETE_SELF.html
+/// [`IN_MODIFY`]: constant.IN_MODIFY.html
+/// [`IN_MOVE_SELF`]: constant.IN_MOVE_SELF.html
+/// [`IN_MOVED_FROM`]: constant.IN_MOVED_FROM.html
+/// [`IN_MOVED_TO`]: constant.IN_MOVED_TO.html
+/// [`IN_OPEN`]: constant.IN_OPEN.html
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_ALL_EVENTS: uint32_t = (
+ IN_ACCESS | IN_MODIFY | IN_ATTRIB | IN_CLOSE_WRITE | IN_CLOSE_NOWRITE
+ | IN_OPEN | IN_MOVED_FROM | IN_MOVED_TO | IN_CREATE | IN_DELETE
+ | IN_DELETE_SELF | IN_MOVE_SELF);
+
+/// Only watch path, if it is a directory
+///
+/// This bit can be set in [`inotify_add_watch`]'s `mask` parameter, to
+/// configure the watch.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_ONLYDIR: uint32_t = 0x01000000;
+
+/// Don't dereference path, if it is a symbolic link
+///
+/// This bit can be set in [`inotify_add_watch`]'s `mask` parameter, to
+/// configure the watch.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_DONT_FOLLOW: uint32_t = 0x02000000;
+
+/// Ignore events for children, that have been unlinked from watched directory
+///
+/// This bit can be set in [`inotify_add_watch`]'s `mask` parameter, to
+/// configure the watch.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_EXCL_UNLINK: uint32_t = 0x04000000;
+
+/// Update existing watch mask, instead of replacing it
+///
+/// This bit can be set in [`inotify_add_watch`]'s `mask` parameter, to
+/// configure the watch.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_MASK_ADD: uint32_t = 0x20000000;
+
+/// Remove watch after one event
+///
+/// This bit can be set in [`inotify_add_watch`]'s `mask` parameter, to
+/// configure the watch.
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_add_watch`]: fn.inotify_add_watch.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_ONESHOT: uint32_t = 0x80000000;
+
+/// Indicates that the subject of an event is a directory
+///
+/// This constant can be used to check against the [`mask`] field in
+/// [`inotify_event`].
+///
+/// See [man page] for additional details.
+///
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [`inotify_event`]: struct.inotify_event.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_ISDIR: uint32_t = 0x40000000;
+
+/// Indicates that file system containing a watched object has been unmounted
+///
+/// An [`IN_IGNORED`] event will be generated subsequently.
+///
+/// This constant can be used to check against the [`mask`] field in
+/// [`inotify_event`].
+///
+/// See [man page] for additional details.
+///
+/// [`IN_IGNORED`]: constant.IN_IGNORED.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [`inotify_event`]: struct.inotify_event.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_UNMOUNT: uint32_t = 0x00002000;
+
+/// Indicates that the event queue has overflowed
+///
+/// This constant can be used to check against the [`mask`] field in
+/// [`inotify_event`].
+///
+/// See [man page] for additional details.
+///
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [`inotify_event`]: struct.inotify_event.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_Q_OVERFLOW: uint32_t = 0x00004000;
+
+/// Indicates that a file system watch was removed
+///
+/// This can occur as a result of [`inotify_rm_watch`], because a watched item
+/// was deleted, the containing filesystem was unmounted, or after a
+/// [`IN_ONESHOT`] watch is complete.
+///
+/// This constant can be used to check against the [`mask`] field in
+/// [`inotify_event`].
+///
+/// See [man page] for additional details.
+///
+/// [`inotify_rm_watch`]: fn.inotify_rm_watch.html
+/// [`IN_ONESHOT`]: constant.IN_ONESHOT.html
+/// [`mask`]: struct.inotify_event.html#structfield.mask
+/// [`inotify_event`]: struct.inotify_event.html
+/// [man page]: http://man7.org/linux/man-pages/man7/inotify.7.html
+pub const IN_IGNORED: uint32_t = 0x00008000;
+
+
+/// Describes a file system event
+///
+/// From [inotify(7)]:
+///
+/// > To determine what events have occurred, an application [read(2)]s
+/// > from the inotify file descriptor. If no events have so far occurred,
+/// > then, assuming a blocking file descriptor, [read(2)] will block until
+/// > at least one event occurs (unless interrupted by a signal, in which
+/// > case the call fails with the error EINTR; see [signal(7)]).
+/// >
+/// > Each successful [read(2)] returns a buffer containing one or more of
+/// > this structure.
+///
+/// [inotify(7)]: http://man7.org/linux/man-pages/man7/inotify.7.html
+/// [read(2)]: http://man7.org/linux/man-pages/man2/read.2.html
+/// [signal(7)]: http://man7.org/linux/man-pages/man7/signal.7.html
+#[allow(non_camel_case_types)]
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct inotify_event {
+ /// Identifies the watch for which this event occurs
+ ///
+ /// This is one of the watch descriptors returned by a previous call to
+ /// [`inotify_add_watch()`].
+ ///
+ /// [`inotify_add_watch()`]: fn.inotify_add_watch.html
+ pub wd: c_int,
+
+ /// Describes the type file system event
+ ///
+ /// One of the following bits will be set, to identify the type of event:
+ ///
+ /// - [`IN_ACCESS`]
+ /// - [`IN_ATTRIB`]
+ /// - [`IN_CLOSE_NOWRITE`]
+ /// - [`IN_CLOSE_WRITE`]
+ /// - [`IN_CREATE`]
+ /// - [`IN_DELETE`]
+ /// - [`IN_DELETE_SELF`]
+ /// - [`IN_IGNORED`]
+ /// - [`IN_MODIFY`]
+ /// - [`IN_MOVED_FROM`]
+ /// - [`IN_MOVED_TO`]
+ /// - [`IN_MOVE_SELF`]
+ /// - [`IN_OPEN`]
+ /// - [`IN_Q_OVERFLOW`]
+ /// - [`IN_UNMOUNT`]
+ ///
+ /// Some constants cover multiple bits, and can be used for a less precise
+ /// check of the event type:
+ ///
+ /// - [`IN_CLOSE`]
+ /// - [`IN_MOVE`]
+ ///
+ /// In addition, the [`IN_ISDIR`] bit can be set.
+ ///
+ /// [`IN_ACCESS`]: constant.IN_ACCESS.html
+ /// [`IN_ATTRIB`]: constant.IN_ATTRIB.html
+ /// [`IN_CLOSE`]: constant.IN_CLOSE.html
+ /// [`IN_CLOSE_NOWRITE`]: constant.IN_CLOSE_NOWRITE.html
+ /// [`IN_CLOSE_WRITE`]: constant.IN_CLOSE_WRITE.html
+ /// [`IN_CREATE`]: constant.IN_CREATE.html
+ /// [`IN_DELETE`]: constant.IN_DELETE.html
+ /// [`IN_DELETE_SELF`]: constant.IN_DELETE_SELF.html
+ /// [`IN_IGNORED`]: constant.IN_IGNORED.html
+ /// [`IN_ISDIR`]: constant.IN_ISDIR.html
+ /// [`IN_MODIFY`]: constant.IN_MODIFY.html
+ /// [`IN_MOVE`]: constant.IN_MOVE.html
+ /// [`IN_MOVED_FROM`]: constant.IN_MOVED_FROM.html
+ /// [`IN_MOVED_TO`]: constant.IN_MOVED_TO.html
+ /// [`IN_MOVE_SELF`]: constant.IN_MOVE_SELF.html
+ /// [`IN_OPEN`]: constant.IN_OPEN.html
+ /// [`IN_Q_OVERFLOW`]: constant.IN_Q_OVERFLOW.html
+ /// [`IN_UNMOUNT`]: constant.IN_UNMOUNT.html
+ pub mask: uint32_t,
+
+ /// A number that connects related events
+ ///
+ /// Currently used only for rename events. A related pair of
+ /// [`IN_MOVED_FROM`] and [`IN_MOVED_TO`] events will have the same,
+ /// non-zero, cookie. For all other events, cookie is 0.
+ ///
+ /// [`IN_MOVED_FROM`]: constant.IN_MOVED_FROM.html
+ /// [`IN_MOVED_TO`]: constant.IN_MOVED_TO.html
+ pub cookie: uint32_t,
+
+ /// The length of `name`
+ ///
+ /// Used to determine the size of this structure. When `name`
+ /// isn't present (`name` is only present when an event occurs
+ /// for a file inside a watched directory), it is 0. When `name`
+ /// *is* present, it counts all of `name`'s bytes, including `\0`.
+ ///
+ /// > 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.
+ ///
+ /// The `name` field has been ommited in this struct's definition.
+ pub len: uint32_t,
+}
+
+
+extern {
+ /// Creates an inotify instance
+ ///
+ /// If you need more flexibility, consider using [`inotify_init1`] instead.
+ ///
+ /// Returns `-1`, if an error occured, or an inotify file descriptor
+ /// otherwise.
+ ///
+ /// Please refer to the [man page] for additional details.
+ ///
+ /// [`inotify_init1`]: fn.inotify_init1.html
+ /// [man page]: http://man7.org/linux/man-pages/man2/inotify_init.2.html
+ pub fn inotify_init() -> c_int;
+
+ /// Creates an inotify instance
+ ///
+ /// Takes an argument to configure the new inotify instance. The following
+ /// flags can be set:
+ ///
+ /// - [`IN_CLOEXEC`]
+ /// - [`IN_NONBLOCK`]
+ ///
+ /// Returns `-1`, if an error occured, or an inotify file descriptor
+ /// otherwise.
+ ///
+ /// Please refer to the [man page] for additional details.
+ ///
+ /// [`IN_CLOEXEC`]: constant.IN_CLOEXEC.html
+ /// [`IN_NONBLOCK`]: constant.IN_NONBLOCK.html
+ /// [man page]: http://man7.org/linux/man-pages/man2/inotify_init1.2.html
+ pub fn inotify_init1(flags: c_int) -> c_int;
+
+ /// Adds or updates an inotify watch
+ ///
+ /// Adds an item to the watch list of an inotify instance, or modifies an
+ /// item on that list. This function takes the following arguments:
+ ///
+ /// - `fd` is the file descriptor of the inotify instance (created by
+ /// [`inotify_init`] or [`inotify_init1`])
+ /// - `pathname` is the path of the file or directory watch
+ /// - `mask` defines the behavior of this function and configures the watch
+ ///
+ /// The following flags in `mask` control the type of events to watch for:
+ ///
+ /// - [`IN_ACCESS`]
+ /// - [`IN_ATTRIB`]
+ /// - [`IN_CLOSE_NOWRITE`]
+ /// - [`IN_CLOSE_WRITE`]
+ /// - [`IN_CREATE`]
+ /// - [`IN_DELETE`]
+ /// - [`IN_DELETE_SELF`]
+ /// - [`IN_MODIFY`]
+ /// - [`IN_MOVED_FROM`]
+ /// - [`IN_MOVED_TO`]
+ /// - [`IN_MOVE_SELF`]
+ /// - [`IN_OPEN`]
+ ///
+ /// The following constants can be used as shortcuts to set multiple event
+ /// flags:
+ ///
+ /// - [`IN_ALL_EVENTS`]
+ /// - [`IN_CLOSE`]
+ /// - [`IN_MOVE`]
+ ///
+ /// In addition, the following flags can be set to control the behaviors of
+ /// the watch and this function:
+ ///
+ /// - [`IN_DONT_FOLLOW`]
+ /// - [`IN_EXCL_UNLINK`]
+ /// - [`IN_MASK_ADD`]
+ /// - [`IN_ONESHOT`]
+ /// - [`IN_ONLYDIR`]
+ ///
+ /// The function returns `-1` if an error occured. Otherwise, it returns a
+ /// watch descriptor that can be used to remove the watch using
+ /// [`inotify_rm_watch`] or identify the watch via [`inotify_event`]'s [wd`]
+ /// field.
+ ///
+ /// Please refer to the [man page] for additional details.
+ ///
+ /// [`inotify_init`]: fn.inotify_init.html
+ /// [`inotify_init1`]: fn.inotify_init1.html
+ /// [`IN_ACCESS`]: constant.IN_ACCESS.html
+ /// [`IN_ATTRIB`]: constant.IN_ATTRIB.html
+ /// [`IN_CLOSE_NOWRITE`]: constant.IN_CLOSE_NOWRITE.html
+ /// [`IN_CLOSE_WRITE`]: constant.IN_CLOSE_WRITE.html
+ /// [`IN_CREATE`]: constant.IN_CREATE.html
+ /// [`IN_DELETE`]: constant.IN_DELETE.html
+ /// [`IN_DELETE_SELF`]: constant.IN_DELETE_SELF.html
+ /// [`IN_MODIFY`]: constant.IN_MODIFY.html
+ /// [`IN_MOVED_FROM`]: constant.IN_MOVED_FROM.html
+ /// [`IN_MOVED_TO`]: constant.IN_MOVED_TO.html
+ /// [`IN_MOVE_SELF`]: constant.IN_MOVE_SELF.html
+ /// [`IN_OPEN`]: constant.IN_OPEN.html
+ /// [`IN_ALL_EVENTS`]: constant.IN_ALL_EVENTS.html
+ /// [`IN_CLOSE`]: constant.IN_CLOSE.html
+ /// [`IN_MOVE`]: constant.IN_MOVE.html
+ /// [`IN_DONT_FOLLOW`]: constant.IN_DONT_FOLLOW.html
+ /// [`IN_EXCL_UNLINK`]: constant.IN_EXCL_UNLINK.html
+ /// [`IN_MASK_ADD`]: constant.IN_MASK_ADD.html
+ /// [`IN_ONESHOT`]: constant.IN_ONESHOT.html
+ /// [`IN_ONLYDIR`]: constant.IN_ONLYDIR.html
+ /// [`inotify_rm_watch`]: fn.inotify_rm_watch.html
+ /// [`inotify_event`]: struct.inotify_event.html
+ /// [`wd`]: struct.inotify_event.html#structfield.wd
+ /// [man page]: http://man7.org/linux/man-pages/man2/inotify_add_watch.2.html
+ pub fn inotify_add_watch(fd: c_int, pathname: *const c_char, mask: uint32_t) -> c_int;
+
+ /// Removes an inotify watch
+ ///
+ /// Removes an item from the watch list of an inotify instance. The inotify
+ /// instance is identified by the `fd` argument. The watch is identified by
+ /// the `wd` argument.
+ ///
+ /// Returns `0` on success, `-1` on failure.
+ ///
+ /// Please refer to the [man page] for additional details.
+ ///
+ /// [man page]: http://man7.org/linux/man-pages/man2/inotify_rm_watch.2.html
+ pub fn inotify_rm_watch(fd: c_int, wd: c_int) -> c_int;
+}
+
+pub use libc::{
+ close,
+ read,
+};
