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
use super::*; /// Builder to customise path styling pub struct StyleBuilder<'a> { object_key_prefix: Option<&'a str>, object_key_suffix: Option<&'a str>, object_keys_in_path: Option<bool>, skip_object_parents: Option<bool>, array_key_prefix: Option<&'a str>, array_key_suffix: Option<&'a str>, array_keys_in_path: Option<bool>, skip_array_parents: Option<bool>, } impl<'a> StyleBuilder<'a> { pub fn new() -> Self { StyleBuilder { object_key_prefix: None, object_key_suffix: None, object_keys_in_path: None, skip_object_parents: None, array_key_prefix: None, array_key_suffix: None, array_keys_in_path: None, skip_array_parents: None, } } /// Clears the currently specified object key prefix value pub fn default_object_key_prefix(mut self) -> Self { self.object_key_prefix = None; self } /// Sets the object key prefix value /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .object_key_prefix(">>>") /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: ">>>apple\"][0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn object_key_prefix(mut self, value: &'a str) -> Self { self.object_key_prefix = Some(value); self } /// Clears the currently specified object key suffix value pub fn default_object_key_suffix(mut self) -> Self { self.object_key_suffix = None; self } /// Sets the object key suffix value /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .object_key_suffix("$$$") /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple$$$[0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn object_key_suffix(mut self, value: &'a str) -> Self { self.object_key_suffix = Some(value); self } /// Clears whether to show or hide object key values in the Element path pub fn default_object_keys_in_path(mut self) -> Self { self.object_keys_in_path = None; self } /// Sets the object key values to be visible in the Element path /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .show_object_keys_in_path() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"][0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn show_object_keys_in_path(mut self) -> Self { self.object_keys_in_path = Some(true); self } /// Sets the object key values to be hidden in the Element path /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .hide_object_keys_in_path() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"\"][0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn hide_object_keys_in_path(mut self) -> Self { self.object_keys_in_path = Some(false); self } /// Clears whether to skip or include values that are objects in the set of yielded values pub fn default_object_parents(mut self) -> Self { self.skip_object_parents = None; self } /// Sets values that are objects to be yielded by the Iterator /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .skip_object_parents() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"][0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn skip_object_parents(mut self) -> Self { self.skip_object_parents = Some(true); self } /// Prevents values that are objects from being yielded by the Iterator /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .include_object_parents() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "".into(), indices: vec![], value: &json!({"apple": [1, true, "three"]}), }); /// ``` pub fn include_object_parents(mut self) -> Self { self.skip_object_parents = Some(false); self } /// Clears the currently specified array_key_prefix value pub fn default_array_key_prefix(mut self) -> Self { self.array_key_prefix = None; self } /// Sets the array_key_prefix value /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .array_key_prefix(":::") /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"]:::0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn array_key_prefix(mut self, value: &'a str) -> Self { self.array_key_prefix = Some(value); self } /// Clears the currently specified array key suffix value pub fn default_array_key_suffix(mut self) -> Self { self.array_key_suffix = None; self } /// Sets the array key suffix value /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .array_key_suffix("!!!") /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"][0!!!".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn array_key_suffix(mut self, value: &'a str) -> Self { self.array_key_suffix = Some(value); self } /// Clears whether to show or hide array key values in the Element path pub fn default_array_keys_in_path(mut self) -> Self { self.array_keys_in_path = None; self } /// Sets the array key values to be visible in the Element path /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .show_array_keys_in_path() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"][0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn show_array_keys_in_path(mut self) -> Self { self.array_keys_in_path = Some(true); self } /// Sets the array key values to be hidden in the Element path /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .hide_array_keys_in_path() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"][]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn hide_array_keys_in_path(mut self) -> Self { self.array_keys_in_path = Some(false); self } /// Clears whether to skip or include values that are arrays in the set of yielded values pub fn default_array_parents(mut self) -> Self { self.skip_array_parents = None; self } /// Sets values that are arrays to be yielded by the Iterator /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .skip_array_parents() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"][0]".into(), indices: vec![0], value: &json!(1), }); /// ``` pub fn skip_array_parents(mut self) -> Self { self.skip_array_parents = Some(true); self } /// Prevents values that are arrays from being yielded by the Iterator /// ```rust /// use serde_json::json; /// use json_keypath_iter::{Style, StyleBuilder, Iterator, Element}; /// /// let style: Style = StyleBuilder::new() /// .include_array_parents() /// .build(); /// let value = json!({"apple": [1, true, "three"]}); /// let iter = Iterator::new(&value).use_style(style); /// let items: Vec<_> = iter.collect(); /// /// assert_eq!(items[0], Element { path: "[\"apple\"]".into(), indices: vec![], value: &json!([1, true, "three"]), }); /// ``` pub fn include_array_parents(mut self) -> Self { self.skip_array_parents = Some(false); self } /// Builds a value Style with defaults for any value not specified or previously cleared out pub fn build(&self) -> Style<'a> { Style { object_key_prefix: self.object_key_prefix.unwrap_or("[\""), object_key_suffix: self.object_key_suffix.unwrap_or("\"]"), object_keys_in_path: self.object_keys_in_path.unwrap_or(true), skip_object_parents: self.skip_object_parents.unwrap_or(true), array_key_prefix: self.array_key_prefix.unwrap_or("["), array_key_suffix: self.array_key_suffix.unwrap_or("]"), array_keys_in_path: self.array_keys_in_path.unwrap_or(true), skip_array_parents: self.skip_array_parents.unwrap_or(true), } } }