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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
#![doc(html_root_url = "https://docs.rs/reopen/0.2.2/reopen/")] #![warn(missing_docs)] //! A tiny `Read`/`Write` wrapper that can reopen the underlying IO object. //! //! The main motivation is integration of logging with logrotate. Usually, when //! logrotate wants to rotate log files, it moves the current log file to a new //! place and creates a new empty file. However, for the new messages to appear in //! the new file, a running program needs to close and reopen the file. This is //! most often signalled by SIGHUP. //! //! # Examples //! //! This allows reopening the IO object used inside the logging drain at runtime. //! //! ```rust //! extern crate libc; //! #[macro_use] //! extern crate log; //! extern crate reopen; //! extern crate simple_logging; //! //! use std::fs::{File, OpenOptions}; //! use std::io::Error; //! //! use reopen::Reopen; //! //! fn open() -> Result<File, Error> { //! OpenOptions::new() //! .create(true) //! .write(true) //! .append(true) //! .open("/dev/null") //! } //! //! fn main() -> Result<(), Error> { //! let file = Reopen::new(Box::new(&open))?; //! file.handle().register_signal(libc::SIGHUP).unwrap(); //! simple_logging::log_to(file, log::LevelFilter::Debug); //! info!("Hey, it's logging"); //! Ok(()) //! } //! ``` //! //! Note that this solution is a bit hacky and probably solves only the most common use case. //! //! If you find another use case for it, I'd like to hear about it. use std::io::{Error, Read, Write}; use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::Arc; #[cfg(unix)] mod signals; /// A handle to signal a companion [`Reopen`](struct.Reopen.html) object to do a reopen on its next /// operation. #[derive(Clone, Debug)] pub struct Handle(Arc<AtomicBool>); impl Handle { /// Signals the companion [`Reopen`](struct.Reopen.html) object to do a reopen on its next /// operation. pub fn reopen(&self) { self.0.store(true, Ordering::Relaxed); } /// Creates a useless handle, not paired to anything. /// /// Note that this useless handle can be added to a new [`Reopen`](struct.Reopen.html) with the /// [`with_handle`](struct.Reopen.html#method.with_handle) and becomes useful. pub fn stub() -> Self { Handle(Arc::new(AtomicBool::new(true))) } } /// A `Read`/`Write` proxy that can reopen the underlying object. /// /// It is constructed with a function that can open a new instance of the object. If it is signaled /// to reopen it (though [`handle`](#method.handle)), it drops the old instance and uses the /// function to create a new one at the next IO operation. /// /// # Error handling /// /// The reopening is performed lazily, on the first operation done to the object. Opening a new /// instance can fail with an error. If this happens, the error is returned as part of the /// operation being performed ‒ therefore, you can get an error like `File not found` while /// performing `read`. /// /// If an error happens, the operation is aborted. Next time an operation is performed, another /// attempt to open the object is made (which in turn can fail again). pub struct Reopen<FD> { signal: Arc<AtomicBool>, constructor: Box<Fn() -> Result<FD, Error> + Send>, fd: Option<FD>, } impl<FD> Reopen<FD> { /// Creates a new instance. pub fn new(constructor: Box<Fn() -> Result<FD, Error> + Send>) -> Result<Self, Error> { Self::with_handle(Handle::stub(), constructor) } /// Creates a new instance from the given handle. /// /// This might come useful if you want to create the handle beforehand with /// [`Handle::stub`](struct.Handle.html#method.stub) (eg. in /// [`lazy_static`](https://docs.rs/lazy_static)). /// /// Note that using the same handle for multiple `Reopen`s will not work as expected (the first /// one to be used resets the signal and the others don't reopen). /// /// # Examples /// /// ``` /// # use reopen::*; /// // Something that implements `Write`, for example. /// struct Writer; /// /// let handle = Handle::stub(); /// let reopen = Reopen::with_handle(handle.clone(), Box::new(|| Ok(Writer))); /// /// handle.reopen(); /// ``` pub fn with_handle( handle: Handle, constructor: Box<Fn() -> Result<FD, Error> + Send>, ) -> Result<Self, Error> { let fd = constructor()?; Ok(Self { signal: handle.0, constructor, fd: Some(fd), }) } /// Returns a handle to signal this `Reopen` to perform the reopening. pub fn handle(&self) -> Handle { Handle(Arc::clone(&self.signal)) } fn check(&mut self) -> Result<&mut FD, Error> { if self.signal.swap(false, Ordering::Relaxed) { self.fd.take(); } if self.fd.is_none() { self.fd = Some((self.constructor)()?); } Ok(self.fd.as_mut().unwrap()) } } impl<FD: Read> Read for Reopen<FD> { fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error> { self.check().and_then(|fd| fd.read(buf)) } } impl<FD: Write> Write for Reopen<FD> { fn write(&mut self, buf: &[u8]) -> Result<usize, Error> { self.check().and_then(|fd| fd.write(buf)) } fn flush(&mut self) -> Result<(), Error> { self.check().and_then(Write::flush) } }