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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
use crate::config::Config; use std::path::Path; /// All types that are possible arguments to [`cmd!`] have to implement this trait. pub trait CmdArgument { #[doc(hidden)] fn prepare_config(self, config: &mut Config); } /// Blanket implementation for `&_`. impl<T> CmdArgument for &T where T: CmdArgument + Clone, { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { self.clone().prepare_config(config); } } /// Arguments of type [`&str`] are passed into the child process /// as arguments. impl CmdArgument for &str { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { config.arguments.push(self.to_string()); } } /// Arguments of type [`String`] are passed into the child process /// as arguments. impl CmdArgument for String { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { config.arguments.push(self); } } /// See the [`CmdArgument`] implementation for [`Split`] below. pub struct Split<'a>(pub &'a str); /// Splits the contained string by whitespace (using [`split_whitespace`]) /// and uses the resulting words as separate arguments. /// /// ``` /// use cradle::*; /// /// let StdoutTrimmed(output) = cmd!(Split("echo foo")); /// assert_eq!(output, "foo"); /// ``` /// /// Since this is such a common case, `cradle` also provides a syntactic shortcut /// for [`Split`], the `%` symbol: /// /// ``` /// use cradle::*; /// /// let StdoutTrimmed(output) = cmd!(%"echo foo"); /// assert_eq!(output, "foo"); /// ``` /// /// [`split_whitespace`]: str::split_whitespace impl<'a> CmdArgument for Split<'a> { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { for argument in self.0.split_whitespace() { config.arguments.push(argument.to_string()); } } } /// Allows to use [`split`] to split your argument into words: /// /// ``` /// use cradle::*; /// /// let StdoutTrimmed(output) = cmd!("echo foo".split(' ')); /// assert_eq!(output, "foo"); /// ``` /// /// Arguments to [`split`] must be of type [`char`]. /// /// [`split`]: str::split impl<'a> CmdArgument for std::str::Split<'a, char> { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { for word in self { word.prepare_config(config); } } } /// Allows to use [`split_whitespace`] to split your argument into words: /// /// ``` /// use cradle::*; /// /// let StdoutTrimmed(output) = cmd!("echo foo".split_whitespace()); /// assert_eq!(output, "foo"); /// ``` /// /// [`split_whitespace`]: str::split_whitespace impl<'a> CmdArgument for std::str::SplitWhitespace<'a> { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { for word in self { word.prepare_config(config); } } } /// Allows to use [`split_ascii_whitespace`] to split your argument into words: /// /// ``` /// use cradle::*; /// /// let StdoutTrimmed(output) = cmd!("echo foo".split_ascii_whitespace()); /// assert_eq!(output, "foo"); /// ``` /// /// [`split_ascii_whitespace`]: str::split_ascii_whitespace impl<'a> CmdArgument for std::str::SplitAsciiWhitespace<'a> { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { for word in self { word.prepare_config(config); } } } /// All elements of the given [`Vec`] are used as arguments to [`cmd!`]. /// Same as passing in the elements separately. /// /// ``` /// use cradle::*; /// /// let StdoutTrimmed(output) = cmd!(vec!["echo", "foo"]); /// assert_eq!(output, "foo"); /// ``` impl<T> CmdArgument for Vec<T> where T: CmdArgument, { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { for t in self.into_iter() { t.prepare_config(config); } } } /// Similar to the implementation for [`Vec<T>`]. /// All elements of the array will be used as arguments. /// /// ``` /// use cradle::*; /// /// let StdoutTrimmed(output) = cmd!(["echo", "foo"]); /// assert_eq!(output, "foo"); /// ``` /// /// Only works on rust version `1.51` and up. #[rustversion::since(1.51)] impl<T, const N: usize> CmdArgument for [T; N] where T: CmdArgument, { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { for t in std::array::IntoIter::new(self) { t.prepare_config(config); } } } /// Similar to the implementation for [`Vec<T>`]. /// All elements of the slice will be used as arguments. impl<T> CmdArgument for &[T] where T: CmdArgument + Clone, { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { self.to_vec().prepare_config(config); } } /// See the [`CmdArgument`] implementation for [`LogCommand`] below. #[derive(Clone, Debug)] pub struct LogCommand; /// Passing in [`LogCommand`] as an argument to [`cmd!`] will cause it /// to log the commands (including all arguments) to `stderr`. /// (This is similar `bash`'s `-x` option.) /// /// ``` /// use cradle::*; /// /// cmd_unit!(LogCommand, %"echo foo"); /// // writes '+ echo foo' to stderr /// ``` impl CmdArgument for LogCommand { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { config.log_command = true; } } /// See the [`CmdArgument`] implementation for [`CurrentDir`] below. pub struct CurrentDir<T: AsRef<Path>>(pub T); /// By default child processes inherit the current directory from their /// parent. You can override this with [`CurrentDir`]: /// /// ``` /// use cradle::*; /// /// # #[cfg(target_os = "linux")] /// # { /// let StdoutTrimmed(output) = cmd!("pwd", CurrentDir("/tmp")); /// assert_eq!(output, "/tmp"); /// # } /// ``` /// /// Paths that are relative to the parent's current directory are allowed. impl<T> CmdArgument for CurrentDir<T> where T: AsRef<Path>, { #[doc(hidden)] fn prepare_config(self, config: &mut Config) { config.working_directory = Some(self.0.as_ref().to_owned()); } }