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 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
//! Convenient conversion traits. // // This module contains traits which make using the SDK feel a little bit more like using a // dynamically-typed language. By making our methods take `impl ToHeaderName`, for example, rather // than `HeaderName`, we allow a variety of types to be used as arguments without burdening the end // user with a lot of explicit conversions. // // These traits are similar in spirit to [`std::convert::TryInto`] but with two key differences: // // 1. Where `TryInto` has an associated error type, we instead panic when a conversion fails. The // documentation for each trait describes which conversions can fail, and we encourage using // explicit conversions with error handling when the source value is untrusted. // // 2. Some complicated trait design is used so that if a method does not need an owned value, it // can borrow the value passed in and avoid a clone. Luckily, we are able to use sealed traits to // hide this complexity from the end user. #[macro_use] mod macros; use crate::backend::Backend; use ::url::Url; use http::header::{HeaderName, HeaderValue}; use http::{Method, StatusCode}; use std::convert::TryFrom; pub use self::backend::ToBackend; pub(crate) use self::borrowable::Borrowable; pub use self::header_name::ToHeaderName; pub use self::header_value::ToHeaderValue; pub use self::method::ToMethod; pub use self::status_code::ToStatusCode; pub use self::url::ToUrl; mod borrowable { pub trait Borrowable<T> { fn as_ref(&self) -> &T; } } mod header_name { use super::*; /// Types that can be converted to a [`HeaderName`]. /// /// Some methods in this crate accept `impl ToHeaderName` arguments. Any of the types below can /// be passed as those arguments and the conversion will be performed automatically, though /// depending on the type, the conversion can panic. /// /// | Source type | Can panic? | Non-panicking conversion | /// |------------------------------------------------------------|------------|----------------------------| /// | [`HeaderName` or `&HeaderName`][`HeaderName`] | No | N/A | /// | [`HeaderValue` or `&HeaderValue`][`HeaderValue`] | Yes | [`HeaderName::try_from()`] | /// | [`&str`][`str`], [`String`, or `&String`][`String`] | Yes | [`HeaderName::try_from()`] | /// | [`&[u8]`][`std::slice`], [`Vec<u8>`, or `&Vec<u8>`][`Vec`] | Yes | [`HeaderName::try_from()`] | /// /// # Panics /// /// This conversion trait differs from [`std::convert::Into`], which is guaranteed to succeed /// for any argument, and [`std::convert::TryInto`] which returns an explicit error when a /// conversion fails. /// /// For types marked above as **Can panic?**, the conversion may panic at runtime if the data is /// invalid. Automatic conversions for these types are provided for convenience for data you /// trust, like a string literal in your code, or for applications where a default `500 Internal /// Server Error` response for a conversion failure is acceptable. /// /// In most applications you should explicitly convert data from untrusted sources, such as the /// client request, to one of the types that cannot fail at runtime using a method like those /// listed under **Non-panicking conversion**. This allows your application to handle conversion /// errors without panicking, such as by falling back on a default value, removing invalid /// characters, or returning a branded error page. pub trait ToHeaderName: Sealed {} convert_stringy!( @with_byte_impls, HeaderName, ToHeaderName, Sealed, "invalid HTTP header name", std::fmt::Debug, std::fmt::Display ); impl ToHeaderName for HeaderValue {} impl ToHeaderName for &HeaderValue {} impl Sealed for HeaderValue { type Borrowable = HeaderName; fn into_borrowable(self) -> Self::Borrowable { Sealed::into_borrowable(self.as_bytes()) } fn into_owned(self) -> HeaderName { Sealed::into_owned(self.as_bytes()) } } impl Sealed for &HeaderValue { type Borrowable = HeaderName; fn into_borrowable(self) -> Self::Borrowable { Sealed::into_borrowable(self.as_bytes()) } fn into_owned(self) -> HeaderName { Sealed::into_owned(self.as_bytes()) } } } mod header_value { use super::*; /// Types that can be converted to a [`HeaderValue`]. /// /// Some methods in this crate accept `impl ToHeaderValue` arguments. Any of the types below can /// be passed as those arguments and the conversion will be performed automatically, though /// depending on the type, the conversion can panic. /// /// | Source type | Can panic? | Non-panicking conversion | /// |------------------------------------------------------------|------------|-----------------------------| /// | [`HeaderName` or `&HeaderName`][`HeaderName`] | No | N/A | /// | [`HeaderValue` or `&HeaderValue`][`HeaderValue`] | No | N/A | /// | [`Url or &Url`][`Url`] | No | N/A | /// | [`&str`][`str`], [`String`, or `&String`][`String`] | Yes | [`HeaderValue::try_from()`] | /// | [`&[u8]`][`std::slice`], [`Vec<u8>`, or `&Vec<u8>`][`Vec`] | Yes | [`HeaderValue::try_from()`] | /// /// # Panics /// /// This conversion trait differs from [`std::convert::Into`], which is guaranteed to succeed /// for any argument, and [`std::convert::TryInto`] which returns an explicit error when a /// conversion fails. /// /// For types marked above as **Can panic?**, the conversion may panic at runtime if the data is /// invalid. Automatic conversions for these types are provided for convenience for data you /// trust, like a string literal in your code, or for applications where a default `500 Internal /// Server Error` response for a conversion failure is acceptable. /// /// In most applications you should explicitly convert data from untrusted sources, such as the /// client request, to one of the types that cannot fail at runtime using a method like those /// listed under **Non-panicking conversion**. This allows your application to handle conversion /// errors without panicking, such as by falling back on a default value, removing invalid /// characters, or returning a branded error page. pub trait ToHeaderValue: Sealed {} convert_stringy!( @with_byte_impls, HeaderValue, ToHeaderValue, Sealed, "invalid HTTP header value", std::fmt::Debug ); impl ToHeaderValue for HeaderName {} impl ToHeaderValue for &HeaderName {} impl ToHeaderValue for Url {} impl ToHeaderValue for &Url {} impl Sealed for HeaderName { type Borrowable = HeaderValue; fn into_borrowable(self) -> Self::Borrowable { HeaderValue::from(self) } fn into_owned(self) -> HeaderValue { HeaderValue::from(self) } } impl Sealed for &HeaderName { type Borrowable = HeaderValue; fn into_borrowable(self) -> Self::Borrowable { HeaderValue::from(self.clone()) } fn into_owned(self) -> HeaderValue { HeaderValue::from(self.clone()) } } impl Sealed for Url { type Borrowable = HeaderValue; fn into_borrowable(self) -> Self::Borrowable { self.to_string().into_borrowable() } fn into_owned(self) -> HeaderValue { self.to_string().into_owned() } } impl Sealed for &Url { type Borrowable = HeaderValue; fn into_borrowable(self) -> Self::Borrowable { self.as_str().into_borrowable() } fn into_owned(self) -> HeaderValue { self.as_str().into_owned() } } } mod method { use super::*; /// Types that can be converted to a [`Method`]. /// /// Some methods in this crate accept `impl ToMethod` arguments. Any of the types below can be /// passed as those arguments and the conversion will be performed automatically, though /// depending on the type, the conversion can panic. /// /// | Source type | Can panic? | Non-panicking conversion | /// |------------------------------------------------------------|------------|--------------------------| /// | [`Method` or `&Method`][`Method`] | No | N/A | /// | [`&str`][`str`], [`String`, or `&String`][`String`] | Yes | [`Method::try_from()`] | /// | [`&[u8]`][`std::slice`], [`Vec<u8>`, or `&Vec<u8>`][`Vec`] | Yes | [`Method::try_from()`] | /// /// # Panics /// /// This conversion trait differs from [`std::convert::Into`], which is guaranteed to succeed /// for any argument, and [`std::convert::TryInto`] which returns an explicit error when a /// conversion fails. /// /// For types marked above as **Can panic?**, the conversion may panic at runtime if the data is /// invalid. Automatic conversions for these types are provided for convenience for data you /// trust, like a string literal in your code, or for applications where a default `500 Internal /// Server Error` response for a conversion failure is acceptable. /// /// In most applications you should explicitly convert data from untrusted sources, such as the /// client request, to one of the types that cannot fail at runtime using a method like those /// listed under **Non-panicking conversion**. This allows your application to handle conversion /// errors without panicking, such as by falling back on a default value, removing invalid /// characters, or returning a branded error page. pub trait ToMethod: Sealed {} convert_stringy!( @with_byte_impls, Method, ToMethod, Sealed, "invalid HTTP method", std::fmt::Debug, std::fmt::Display ); } mod url { use super::*; /// Types that can be converted to a [`Url`]. /// /// Some methods in this crate accept `impl ToUrl` arguments. Any of the types below can be /// passed as those arguments and the conversion will be performed automatically, though /// depending on the type, the conversion can panic. /// /// | Source type | Can panic? | Non-panicking conversion | /// |-----------------------------------------------------|------------|--------------------------| /// | [`Url or &Url`][`Url`] | No | N/A | /// | [`&str`][`str`], [`String`, or `&String`][`String`] | Yes | [`Url::parse()`] | /// /// # Panics /// /// This conversion trait differs from [`std::convert::Into`], which is guaranteed to succeed /// for any argument, and [`std::convert::TryInto`] which returns an explicit error when a /// conversion fails. /// /// For types marked above as **Can panic?**, the conversion may panic at runtime if the data is /// invalid. Automatic conversions for these types are provided for convenience for data you /// trust, like a string literal in your code, or for applications where a default `500 Internal /// Server Error` response for a conversion failure is acceptable. /// /// In most applications you should explicitly convert data from untrusted sources, such as the /// client request, to one of the types that cannot fail at runtime using a method like those /// listed under **Non-panicking conversion**. This allows your application to handle conversion /// errors without panicking, such as by falling back on a default value, removing invalid /// characters, or returning a branded error page. pub trait ToUrl: Sealed {} convert_stringy!( Url, ToUrl, Sealed, "invalid URL", std::fmt::Debug, std::fmt::Display ); } mod status_code { use super::*; /// Types that can be converted to a [`StatusCode`]. /// /// Some methods in this crate accept `impl ToStatusCode` arguments. Any of the types below can /// be passed as those arguments and the conversion will be performed automatically, though /// depending on the type, the conversion can panic. /// /// | Source type | Can panic? | Non-panicking conversion | /// |----------------|------------|----------------------------| /// | [`StatusCode`] | No | N/A | /// | [`u16`] | Yes | [`StatusCode::try_from()`] | /// /// # Panics /// /// This conversion trait differs from [`std::convert::Into`], which is guaranteed to succeed /// for any argument, and [`std::convert::TryInto`] which returns an explicit error when a /// conversion fails. /// /// For types marked above as **Can panic?**, the conversion may panic at runtime if the data is /// invalid. Automatic conversions for these types are provided for convenience for data you /// trust, like a string literal in your code, or for applications where a default `500 Internal /// Server Error` response for a conversion failure is acceptable. /// /// In most applications you should explicitly convert data from untrusted sources, such as the /// client request, to one of the types that cannot fail at runtime using a method like those /// listed under **Non-panicking conversion**. This allows your application to handle conversion /// errors without panicking, such as by falling back on a default value, removing invalid /// characters, or returning a branded error page. pub trait ToStatusCode: Sealed {} impl ToStatusCode for StatusCode {} impl ToStatusCode for u16 {} pub trait Sealed { fn to_status_code(self) -> StatusCode; } impl Sealed for StatusCode { fn to_status_code(self) -> StatusCode { self } } impl Sealed for u16 { fn to_status_code(self) -> StatusCode { StatusCode::from_u16(self) .unwrap_or_else(|_| panic!("invalid HTTP status code: {}", self)) } } } mod backend { use super::*; /// Types that can be converted to a [`Backend`]. /// /// Some methods in this crate accept `impl ToBackend` arguments. Any of the types below can be /// passed as those arguments and the conversion will be performed automatically, though /// depending on the type, the conversion can panic. /// /// | Source type | Can panic? | Non-panicking conversion | /// |-----------------------------------------------------|------------|--------------------------| /// | [`Backend or &Backend`][`Backend`] | No | N/A | /// | [`&str`][`str`], [`String`, or `&String`][`String`] | Yes | [`Backend::from_name()`] | /// /// # Panics /// /// This conversion trait differs from [`std::convert::Into`], which is guaranteed to succeed /// for any argument, and [`std::convert::TryInto`] which returns an explicit error when a /// conversion fails. /// /// For types marked above as **Can panic?**, the conversion may panic at runtime if the data is /// invalid. Automatic conversions for these types are provided for convenience for data you /// trust, like a string literal in your code, or for applications where a default `500 Internal /// Server Error` response for a conversion failure is acceptable. /// /// In most applications you should explicitly convert data from untrusted sources, such as the /// client request, to one of the types that cannot fail at runtime using a method like those /// listed under **Non-panicking conversion**. This allows your application to handle conversion /// errors without panicking, such as by falling back on a default value, removing invalid /// characters, or returning a branded error page. pub trait ToBackend: Sealed {} convert_stringy!( Backend, ToBackend, Sealed, "invalid backend", std::fmt::Debug ); }