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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
//! Defines the fields used in the query result structs // don't show deprecation warnings about NewField when we build this file #![allow(deprecated)] use crate::prelude::*; use serde::Deserialize; use std::path::PathBuf; /// This trait is used to furnish the caller with the watchman /// field name for an entry in the file results #[doc(hidden)] pub trait QueryFieldName { fn field_name() -> &'static str; } /// This trait is used to produce the complete list of file /// result field names for a query #[doc(hidden)] pub trait QueryFieldList { fn field_list() -> Vec<&'static str>; } /// This macro defines a field struct that can be composed using /// the `query_result_type!` macro into a struct that can be used /// with the `Client::query` method. macro_rules! define_field {( $(#[$meta:meta])* $tyname:ident, $ty:ty, $field_name:literal) => { #[derive(Deserialize, Clone, Debug)] $(#[$meta])* pub struct $tyname { #[serde(rename = $field_name)] val: $ty, } impl QueryFieldName for $tyname { fn field_name() -> &'static str { $field_name } } impl $tyname { /// Consumes the field and returns the underlying /// value storage pub fn into_inner(self) -> $ty { self.val } } impl std::ops::Deref for $tyname { type Target = $ty; fn deref(&self) -> &Self::Target { &self.val } } impl std::ops::DerefMut for $tyname { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.val } } }; } define_field!( /// The field corresponding to the `name` of the file. NameField, PathBuf, "name" ); define_field!( /// The field corresponding to the `exists` status of the file ExistsField, bool, "exists" ); define_field!( /// The field corresponding to the `cclock` field. /// the cclock is the created clock; the clock value when we first observed the file, /// or the clock value when it last switched from !exists to exists. CreatedClockField, ClockSpec, "cclock" ); define_field!( /// The field corresponding to the `oclock` field. /// the oclock is the observed clock; the clock value where we last observed some /// change in this file or its metadata. ObservedClockField, ClockSpec, "cclock" ); define_field!( /// The field corresponding to the `content.sha1hex` field. /// For regular files this evaluates to the sha1 hash of the /// file contents. ContentSha1HexField, ContentSha1Hex, "content.sha1hex" ); define_field!( /// The field corresponding to the `ctime` field. /// ctime is the last inode change time measured in integer seconds since the /// unix epoch. CTimeField, i64, "ctime" ); define_field!( /// The field corresponding to the `ctime_f` field. /// ctime is the last inode change time measured in floating point seconds /// (including the fractional portion) since the unix epoch. CTimeAsFloatField, f32, "ctime_f" ); define_field!( /// The field corresponding to the `mtime` field. /// mtime is the last modified time measured in integer seconds /// since the unix epoch. MTimeField, i64, "mtime" ); define_field!( /// The field corresponding to the `mtime_f` field. /// mtime is the last modified time measured in floating point seconds /// (including the fractional portion) since the unix epoch. MTimeAsFloatField, f32, "mtime_f" ); define_field!( /// The field corresponding to the `size` field. /// This represents the size of the file in bytes. SizeField, usize, "size" ); define_field!( /// The field corresponding to the `mode` field. /// This encodes the full file type and permission bits. /// Note that most programs and users are more comfortable with /// this value when printed in octal. /// It is recommended to use `FileTypeField` if all you need is the /// file type and not the permission bits, as it is cheaper to /// determine just the type in a virtualized filesystem. ModeAndPermissionsField, u64, "mode" ); define_field!( /// The field corresponding to the `uid` field. /// The uid field is the owning uid expressed as an integer. /// This field is not meaningful on Windows. OwnerUidField, u32, "uid" ); define_field!( /// The field corresponding to the `gid` field. /// The gid field is the owning gid expressed as an integer. /// This field is not meaningful on Windows. OwnerGidField, u32, "gid" ); define_field!( /// The field corresponding to the `ino` field. /// The ino field is the inode number expressed as an integer. /// This field is not meaningful on Windows. InodeNumberField, u64, "ino" ); define_field!( /// The field corresponding to the `dev` field. /// The dev field is the device number expressed as an integer. /// This field is not meaningful on Windows. DeviceNumberField, u64, "dev" ); define_field!( /// The field corresponding to the `nlink` field. /// The nlink field is the number of hard links to the file /// expressed as an integer. NumberOfLinksField, u64, "nlink" ); define_field!( /// The field corresponding to the `type` field. /// The type field encodes the type of the file. FileTypeField, FileType, "type" ); define_field!( /// The field corresponding to the `symlink_target` field. /// For files of type symlink this evaluates to the result /// of readlink(2) on the file. SymlinkTargetField, Option<String>, "symlink_target" ); define_field!( /// The field corresponding to the `new` field. /// The new field evaluates to true if a file is newer than /// the since generator criteria. /// /// Use of this field is discouraged as there are a number of /// situations in which the newness has a counter-intuitive /// value. In addition, computing newness in a virtualized /// filesystem is relatively expensive. /// /// If your application needs to reason about the transition /// from `!exists -> exists` then you should track the /// `ExistsField` in your application. #[deprecated(note = "NewField can have counter-intuitive \ values in a number of situations so it \ is recommended that you track \ ExistsField instead")] NewField, bool, "new" ); /// A macro to help define a type to hold file information from /// a query. /// This macro enables a type-safe way to define the set of fields /// to be returned and de-serialize only those fields. /// /// This defines a struct that will receive the name and content /// hash fields from the results. When used together with /// `Client::query`, the query will automatically use the appropriate /// list of field names: /// /// ``` /// use watchman_client::prelude::*; /// use serde::Deserialize; /// /// query_result_type! { /// struct NameAndHash { /// name: NameField, /// hash: ContentSha1HexField, /// } /// } /// ``` /// /// The struct must consist of 2 or more fields; the macro subsystem /// won't allow for generating an appropriate type definition for a single /// field result. /// /// If you need only a single field, look at [NameOnly](struct.NameOnly.html). /// /// The field types must implement an undocumented trait that enables /// the automatic field naming and correct deserialization regardless /// of the field name in the struct. As such, you should consider /// the set of fields to be limited to those provided by this crate. #[macro_export] macro_rules! query_result_type {( $struct_vis:vis struct $tyname:ident { $($field_vis:vis $field_name:ident : $field_ty:ty),+ $(,)? } ) => ( #[derive(Deserialize, Debug, Clone)] $struct_vis struct $tyname { $( #[serde(flatten)] $field_vis $field_name: $field_ty, )* } impl QueryFieldList for $tyname { fn field_list() -> Vec <&'static str> { vec![ $( <$field_ty>::field_name(), )* ] } } ) } /// Use the `NameOnly` struct when your desired field list in your /// query results consist only of the name field. /// It is not possible to use the `query_result_type!` macro to define /// an appropriate type due to limitations in the Rust macro system. #[derive(Deserialize, Debug, Clone)] #[serde(from = "PathBuf")] pub struct NameOnly { pub name: NameField, } impl QueryFieldList for NameOnly { fn field_list() -> Vec<&'static str> { vec!["name"] } } impl From<PathBuf> for NameOnly { fn from(path: PathBuf) -> Self { Self { name: NameField { val: path }, } } }