DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (1aeaa33a64f9)

VCS Links

Line Code
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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
use traits::FnBox;

/// `SendBoxFnOnce` boxes any `FnOnce + Send` function up to a certain
/// number of arguments (10 as of now).
///
/// As `Box<FnOnce()>` doesn't work yet, and `Box<FnBox()>` will not be
/// available in stable rust, `SendBoxFnOnce` tries to provide a safe
/// implementation.
///
/// Instead of `Box<FnOnce(Args...) -> Result>` (or `Box<FnBox(Args...)
/// -> Result>`) the box type is `SendBoxFnOnce<(Args...,), Result>`  (the
/// arguments are always given as tuple type).  If the function doesn't
/// return a value (i.e. the empty tuple) `Result` can be ommitted:
/// `SendBoxFnOnce<(Args...,)>`.
///
/// Internally it is implemented similar to `Box<FnBox()>`, but there is
/// no `FnOnce` implementation for `SendBoxFnOnce`.
///
/// You can build boxes for diverging functions too, but specifying the
/// type (like `SendBoxFnOnce<(), !>`) is not possible as the `!` type is
/// experimental.
///
/// # Examples
///
/// Move value into closure to return it, box the closure and send it:
///
/// ```
/// use boxfnonce::SendBoxFnOnce;
/// use std::thread;
///
/// let s = String::from("foo");
/// let f : SendBoxFnOnce<(), String> = SendBoxFnOnce::from(|| {
///     println!("Got called: {}", s);
///     s
/// });
/// let result = thread::Builder::new().spawn(move || {
///     f.call()
/// }).unwrap().join().unwrap();
/// assert_eq!(result, "foo".to_string());
/// ```
pub struct SendBoxFnOnce<Arguments, Result = ()> (Box<FnBox<Arguments, Result> + Send>);

impl<Args, Result> SendBoxFnOnce<Args, Result> {
	/// call inner function, consumes the box.
	///
	/// `call_tuple` can be used if the arguments are available as
	/// tuple. Each usable instance of SendBoxFnOnce<(...), Result> has
	/// a separate `call` method for passing arguments "untupled".
	#[inline]
	pub fn call_tuple(self, args: Args) -> Result {
		self.0.call(args)
	}

	/// `SendBoxFnOnce::new` is an alias for `SendBoxFnOnce::from`.
	#[inline]
	pub fn new<F>(func: F) -> Self
	where Self: From<F>
	{
		Self::from(func)
	}
}

build_n_args!(SendBoxFnOnce[+Send]: );
build_n_args!(SendBoxFnOnce[+Send]: a1: A1);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3, a4: A4);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3, a4: A4, a5: A5);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8, a9: A9);
build_n_args!(SendBoxFnOnce[+Send]: a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8, a9: A9, a10: A10);

#[cfg(test)]
mod test {
	use super::SendBoxFnOnce;

	use std::thread;
	use std::sync::Arc;

	struct SendString(String, Arc<()>);
	impl SendString {
		fn into(self) -> String {
			self.0
		}
	}

	fn closure_string() -> SendString {
		SendString(String::from("abc"), Arc::new(()))
	}

	fn try_send<Result, F>(name: &str, func: F) -> thread::Result<Result>
	where
		Result: 'static + Send,
		F: 'static + Send + FnOnce() -> Result
	{
		thread::Builder::new().name(name.to_string()).spawn(func).unwrap().join()
	}

	fn send<Result, F>(func: F) -> Result
	where
		Result: 'static + Send,
		F: 'static + Send + FnOnce() -> Result
	{
		try_send("test thread", func).unwrap()
	}

	#[test]
	fn test_arg0() {
		let f = SendBoxFnOnce::from({
			let s = closure_string();
			|| -> String {
				s.into()
			}
		});
		let result = send(|| {
			f.call()
		});
		assert_eq!(result, "abc");
	}

	#[test]
	fn test_arg1() {
		let f = SendBoxFnOnce::from({
			let s = closure_string();
			|_| -> String {
				s.into()
			}
		});
		let result = send(|| {
			f.call(0)
		});
		assert_eq!(result, "abc");
	}

	#[test]
	fn test_arg1_fixed_argument_type() {
		let f : SendBoxFnOnce<(i32,), String> = SendBoxFnOnce::from({
			let s = closure_string();
			|_| -> String {
				s.into()
			}
		});
		let result = send(|| {
			f.call(0)
		});
		assert_eq!(result, "abc");
	}

	#[test]
	fn test_arg2() {
		let f = SendBoxFnOnce::from({
			let s = closure_string();
			|_, _| -> String {
				s.into()
			}
		});
		let result = send(|| {
			f.call(0, 0)
		});
		assert_eq!(result, "abc");
	}

	#[test]
	fn test_arg3() {
		let f = SendBoxFnOnce::from({
			let s = closure_string();
			|_, _, _| -> String {
				s.into()
			}
		});
		let result = send(|| {
			f.call(0, 0, 0)
		});
		assert_eq!(result, "abc");
	}

	#[test]
	fn test_arg4_void() {
		let f = SendBoxFnOnce::from({
			let s = closure_string();
			|_, _, _, _| {
				drop(s);
			}
		});
		send(|| {
			f.call(0, 0, 0, 0);
		});
	}

	#[test]
	fn test_arg4_diverging() {
		use std::panic;

		let f = SendBoxFnOnce::from({
			let s = closure_string();
			|_, _, _, _| -> ! {
				drop(s);
				// a panic! but without the default hook printing stuff
				panic::resume_unwind(Box::new("inner diverging"));
			}
		});
		let result = try_send("diverging test thread", || {
			f.call(0, 0, 0, 0);
		}).map_err(|e| e.downcast::<&str>().unwrap());
		assert_eq!(result, Err(Box::new("inner diverging")));
	}
}