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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
//! Various utility types and functions that are generally used with Tower.
mod and_then;
mod boxed;
mod call_all;
mod either;
mod future_service;
mod map_err;
mod map_request;
mod map_response;
mod map_result;
mod map_future;
mod oneshot;
mod optional;
mod ready;
mod service_fn;
mod then;
#[allow(deprecated)]
pub use self::{
and_then::{AndThen, AndThenLayer},
boxed::{BoxLayer, BoxService, UnsyncBoxService},
either::Either,
future_service::{future_service, FutureService},
map_err::{MapErr, MapErrLayer},
map_future::{MapFuture, MapFutureLayer},
map_request::{MapRequest, MapRequestLayer},
map_response::{MapResponse, MapResponseLayer},
map_result::{MapResult, MapResultLayer},
oneshot::Oneshot,
optional::Optional,
ready::{Ready, ReadyAnd, ReadyOneshot},
service_fn::{service_fn, ServiceFn},
then::{Then, ThenLayer},
};
pub use self::call_all::{CallAll, CallAllUnordered};
use std::future::Future;
use crate::layer::util::Identity;
pub mod error {
//! Error types
pub use super::optional::error as optional;
}
pub mod future {
//! Future types
pub use super::and_then::AndThenFuture;
pub use super::map_err::MapErrFuture;
pub use super::map_response::MapResponseFuture;
pub use super::map_result::MapResultFuture;
pub use super::optional::future as optional;
pub use super::then::ThenFuture;
}
/// An extension trait for `Service`s that provides a variety of convenient
/// adapters
pub trait ServiceExt<Request>: tower_service::Service<Request> {
/// Yields a mutable reference to the service when it is ready to accept a request.
fn ready(&mut self) -> Ready<'_, Self, Request>
where
Self: Sized,
{
Ready::new(self)
}
/// Yields a mutable reference to the service when it is ready to accept a request.
#[deprecated(
since = "0.4.6",
note = "please use the `ServiceExt::ready` method instead"
)]
#[allow(deprecated)]
fn ready_and(&mut self) -> ReadyAnd<'_, Self, Request>
where
Self: Sized,
{
ReadyAnd::new(self)
}
/// Yields the service when it is ready to accept a request.
fn ready_oneshot(self) -> ReadyOneshot<Self, Request>
where
Self: Sized,
{
ReadyOneshot::new(self)
}
/// Consume this `Service`, calling with the providing request once it is ready.
fn oneshot(self, req: Request) -> Oneshot<Self, Request>
where
Self: Sized,
{
Oneshot::new(self, req)
}
/// Process all requests from the given [`Stream`], and produce a [`Stream`] of their responses.
///
/// This is essentially [`Stream<Item = Request>`][stream] + `Self` => [`Stream<Item =
/// Response>`][stream]. See the documentation for [`CallAll`] for
/// details.
///
/// [`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
/// [stream]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
fn call_all<S>(self, reqs: S) -> CallAll<Self, S>
where
Self: Sized,
Self::Error: Into<crate::BoxError>,
S: futures_core::Stream<Item = Request>,
{
CallAll::new(self, reqs)
}
/// Executes a new future after this service's future resolves. This does
/// not alter the behaviour of the [`poll_ready`] method.
///
/// This method can be used to change the [`Response`] type of the service
/// into a different type. You can use this method to chain along a computation once the
/// service's response has been resolved.
///
/// [`Response`]: crate::Service::Response
/// [`poll_ready`]: crate::Service::poll_ready
///
/// # Example
/// ```
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # struct Record {
/// # pub name: String,
/// # pub age: u16
/// # }
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = Record;
/// # type Error = u8;
/// # type Future = futures_util::future::Ready<Result<Record, u8>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(Record { name: "Jack".into(), age: 32 }))
/// # }
/// # }
/// #
/// # async fn avatar_lookup(name: String) -> Result<Vec<u8>, u8> { Ok(vec![]) }
/// #
/// # fn main() {
/// # async {
/// // A service returning Result<Record, _>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // Map the response into a new response
/// let mut new_service = service.and_then(|record: Record| async move {
/// let name = record.name;
/// avatar_lookup(name).await
/// });
///
/// // Call the new service
/// let id = 13;
/// let avatar = new_service.call(id).await.unwrap();
/// # };
/// # }
/// ```
fn and_then<F>(self, f: F) -> AndThen<Self, F>
where
Self: Sized,
F: Clone,
{
AndThen::new(self, f)
}
/// Maps this service's response value to a different value. This does not
/// alter the behaviour of the [`poll_ready`] method.
///
/// This method can be used to change the [`Response`] type of the service
/// into a different type. It is similar to the [`Result::map`]
/// method. You can use this method to chain along a computation once the
/// service's response has been resolved.
///
/// [`Response`]: crate::Service::Response
/// [`poll_ready`]: crate::Service::poll_ready
///
/// # Example
/// ```
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # struct Record {
/// # pub name: String,
/// # pub age: u16
/// # }
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = Record;
/// # type Error = u8;
/// # type Future = futures_util::future::Ready<Result<Record, u8>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(Record { name: "Jack".into(), age: 32 }))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// // A service returning Result<Record, _>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // Map the response into a new response
/// let mut new_service = service.map_response(|record| record.name);
///
/// // Call the new service
/// let id = 13;
/// let name = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await?;
/// # Ok::<(), u8>(())
/// # };
/// # }
/// ```
fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
where
Self: Sized,
F: FnOnce(Self::Response) -> Response + Clone,
{
MapResponse::new(self, f)
}
/// Maps this service's error value to a different value. This does not
/// alter the behaviour of the [`poll_ready`] method.
///
/// This method can be used to change the [`Error`] type of the service
/// into a different type. It is similar to the [`Result::map_err`] method.
///
/// [`Error`]: crate::Service::Error
/// [`poll_ready`]: crate::Service::poll_ready
///
/// # Example
/// ```
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # struct Error {
/// # pub code: u32,
/// # pub message: String
/// # }
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = String;
/// # type Error = Error;
/// # type Future = futures_util::future::Ready<Result<String, Error>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(String::new()))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// // A service returning Result<_, Error>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // Map the error to a new error
/// let mut new_service = service.map_err(|err| err.code);
///
/// // Call the new service
/// let id = 13;
/// let code = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await
/// .unwrap_err();
/// # Ok::<(), u32>(())
/// # };
/// # }
/// ```
fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
where
Self: Sized,
F: FnOnce(Self::Error) -> Error + Clone,
{
MapErr::new(self, f)
}
/// Maps this service's result type (`Result<Self::Response, Self::Error>`)
/// to a different value, regardless of whether the future succeeds or
/// fails.
///
/// This is similar to the [`map_response`] and [`map_err`] combinators,
/// except that the *same* function is invoked when the service's future
/// completes, whether it completes successfully or fails. This function
/// takes the [`Result`] returned by the service's future, and returns a
/// [`Result`].
///
/// Like the standard library's [`Result::and_then`], this method can be
/// used to implement control flow based on `Result` values. For example, it
/// may be used to implement error recovery, by turning some [`Err`]
/// responses from the service into [`Ok`] responses. Similarly, some
/// successful responses from the service could be rejected, by returning an
/// [`Err`] conditionally, depending on the value inside the [`Ok`.] Finally,
/// this method can also be used to implement behaviors that must run when a
/// service's future completes, regardless of whether it succeeded or failed.
///
/// This method can be used to change the [`Response`] type of the service
/// into a different type. It can also be used to change the [`Error`] type
/// of the service. However, because the [`map_result`] function is not applied
/// to the errors returned by the service's [`poll_ready`] method, it must
/// be possible to convert the service's [`Error`] type into the error type
/// returned by the [`map_result`] function. This is trivial when the function
/// returns the same error type as the service, but in other cases, it can
/// be useful to use [`BoxError`] to erase differing error types.
///
/// # Examples
///
/// Recovering from certain errors:
///
/// ```
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # struct Record {
/// # pub name: String,
/// # pub age: u16
/// # }
/// # #[derive(Debug)]
/// # enum DbError {
/// # Parse(std::num::ParseIntError),
/// # NoRecordsFound,
/// # }
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = Vec<Record>;
/// # type Error = DbError;
/// # type Future = futures_util::future::Ready<Result<Vec<Record>, DbError>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(vec![Record { name: "Jack".into(), age: 32 }]))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// // A service returning Result<Vec<Record>, DbError>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // If the database returns no records for the query, we just want an empty `Vec`.
/// let mut new_service = service.map_result(|result| match result {
/// // If the error indicates that no records matched the query, return an empty
/// // `Vec` instead.
/// Err(DbError::NoRecordsFound) => Ok(Vec::new()),
/// // Propagate all other responses (`Ok` and `Err`) unchanged
/// x => x,
/// });
///
/// // Call the new service
/// let id = 13;
/// let name = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await?;
/// # Ok::<(), DbError>(())
/// # };
/// # }
/// ```
///
/// Rejecting some `Ok` responses:
///
/// ```
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # struct Record {
/// # pub name: String,
/// # pub age: u16
/// # }
/// # type DbError = String;
/// # type AppError = String;
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = Record;
/// # type Error = DbError;
/// # type Future = futures_util::future::Ready<Result<Record, DbError>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(Record { name: "Jack".into(), age: 32 }))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// use tower::BoxError;
///
/// // A service returning Result<Record, DbError>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // If the user is zero years old, return an error.
/// let mut new_service = service.map_result(|result| {
/// let record = result?;
///
/// if record.age == 0 {
/// // Users must have been born to use our app!
/// let app_error = AppError::from("users cannot be 0 years old!");
///
/// // Box the error to erase its type (as it can be an `AppError`
/// // *or* the inner service's `DbError`).
/// return Err(BoxError::from(app_error));
/// }
///
/// // Otherwise, return the record.
/// Ok(record)
/// });
///
/// // Call the new service
/// let id = 13;
/// let record = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await?;
/// # Ok::<(), BoxError>(())
/// # };
/// # }
/// ```
///
/// Performing an action that must be run for both successes and failures:
///
/// ```
/// # use std::convert::TryFrom;
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = String;
/// # type Error = u8;
/// # type Future = futures_util::future::Ready<Result<String, u8>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(String::new()))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// // A service returning Result<Record, DbError>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // Print a message whenever a query completes.
/// let mut new_service = service.map_result(|result| {
/// println!("query completed; success={}", result.is_ok());
/// result
/// });
///
/// // Call the new service
/// let id = 13;
/// let response = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await;
/// # response
/// # };
/// # }
/// ```
///
/// [`map_response`]: ServiceExt::map_response
/// [`map_err`]: ServiceExt::map_err
/// [`map_result`]: ServiceExt::map_result
/// [`Error`]: crate::Service::Error
/// [`Response`]: crate::Service::Response
/// [`poll_ready`]: crate::Service::poll_ready
/// [`BoxError`]: crate::BoxError
fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
where
Self: Sized,
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,
{
MapResult::new(self, f)
}
/// Composes a function *in front of* the service.
///
/// This adapter produces a new service that passes each value through the
/// given function `f` before sending it to `self`.
///
/// # Example
/// ```
/// # use std::convert::TryFrom;
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # impl Service<String> for DatabaseService {
/// # type Response = String;
/// # type Error = u8;
/// # type Future = futures_util::future::Ready<Result<String, u8>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: String) -> Self::Future {
/// # futures_util::future::ready(Ok(String::new()))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// // A service taking a String as a request
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // Map the request to a new request
/// let mut new_service = service.map_request(|id: u32| id.to_string());
///
/// // Call the new service
/// let id = 13;
/// let response = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await;
/// # response
/// # };
/// # }
/// ```
fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
where
Self: Sized,
F: FnMut(NewRequest) -> Request + Clone,
{
MapRequest::new(self, f)
}
/// Composes this service with a [`Filter`] that conditionally accepts or
/// rejects requests based on a [predicate].
///
/// This adapter produces a new service that passes each value through the
/// given function `predicate` before sending it to `self`.
///
/// # Example
/// ```
/// # use std::convert::TryFrom;
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # #[derive(Debug)] enum DbError {
/// # Parse(std::num::ParseIntError)
/// # }
/// #
/// # impl std::fmt::Display for DbError {
/// # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { std::fmt::Debug::fmt(self, f) }
/// # }
/// # impl std::error::Error for DbError {}
/// # impl Service<u32> for DatabaseService {
/// # type Response = String;
/// # type Error = DbError;
/// # type Future = futures_util::future::Ready<Result<String, DbError>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(String::new()))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// // A service taking a u32 as a request and returning Result<_, DbError>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // Fallibly map the request to a new request
/// let mut new_service = service
/// .filter(|id_str: &str| id_str.parse().map_err(DbError::Parse));
///
/// // Call the new service
/// let id = "13";
/// let response = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await;
/// # response
/// # };
/// # }
/// ```
///
/// [`Filter`]: crate::filter::Filter
/// [predicate]: crate::filter::Predicate
#[cfg(feature = "filter")]
#[cfg_attr(docsrs, doc(cfg(feature = "filter")))]
fn filter<F, NewRequest>(self, filter: F) -> crate::filter::Filter<Self, F>
where
Self: Sized,
F: crate::filter::Predicate<NewRequest>,
{
crate::filter::Filter::new(self, filter)
}
/// Composes this service with an [`AsyncFilter`] that conditionally accepts or
/// rejects requests based on an [async predicate].
///
/// This adapter produces a new service that passes each value through the
/// given function `predicate` before sending it to `self`.
///
/// # Example
/// ```
/// # use std::convert::TryFrom;
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # #[derive(Clone)] struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// # #[derive(Debug)]
/// # enum DbError {
/// # Rejected
/// # }
/// # impl std::fmt::Display for DbError {
/// # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { std::fmt::Debug::fmt(self, f) }
/// # }
/// # impl std::error::Error for DbError {}
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = String;
/// # type Error = DbError;
/// # type Future = futures_util::future::Ready<Result<String, DbError>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(String::new()))
/// # }
/// # }
/// #
/// # fn main() {
/// # async {
/// // A service taking a u32 as a request and returning Result<_, DbError>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// /// Returns `true` if we should query the database for an ID.
/// async fn should_query(id: u32) -> bool {
/// // ...
/// # true
/// }
///
/// // Filter requests based on `should_query`.
/// let mut new_service = service
/// .filter_async(|id: u32| async move {
/// if should_query(id).await {
/// return Ok(id);
/// }
///
/// Err(DbError::Rejected)
/// });
///
/// // Call the new service
/// let id = 13;
/// # let id: u32 = id;
/// let response = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await;
/// # response
/// # };
/// # }
/// ```
///
/// [`AsyncFilter`]: crate::filter::AsyncFilter
/// [asynchronous predicate]: crate::filter::AsyncPredicate
#[cfg(feature = "filter")]
#[cfg_attr(docsrs, doc(cfg(feature = "filter")))]
fn filter_async<F, NewRequest>(self, filter: F) -> crate::filter::AsyncFilter<Self, F>
where
Self: Sized,
F: crate::filter::AsyncPredicate<NewRequest>,
{
crate::filter::AsyncFilter::new(self, filter)
}
/// Composes an asynchronous function *after* this service.
///
/// This takes a function or closure returning a future, and returns a new
/// `Service` that chains that function after this service's [`Future`]. The
/// new `Service`'s future will consist of this service's future, followed
/// by the future returned by calling the chained function with the future's
/// [`Output`] type. The chained function is called regardless of whether
/// this service's future completes with a successful response or with an
/// error.
///
/// This method can be thought of as an equivalent to the [`futures`
/// crate]'s [`FutureExt::then`] combinator, but acting on `Service`s that
/// _return_ futures, rather than on an individual future. Similarly to that
/// combinator, [`ServiceExt::then`] can be used to implement asynchronous
/// error recovery, by calling some asynchronous function with errors
/// returned by this service. Alternatively, it may also be used to call a
/// fallible async function with the successful response of this service.
///
/// This method can be used to change the [`Response`] type of the service
/// into a different type. It can also be used to change the [`Error`] type
/// of the service. However, because the `then` function is not applied
/// to the errors returned by the service's [`poll_ready`] method, it must
/// be possible to convert the service's [`Error`] type into the error type
/// returned by the `then` future. This is trivial when the function
/// returns the same error type as the service, but in other cases, it can
/// be useful to use [`BoxError`] to erase differing error types.
///
/// # Examples
///
/// ```
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # type Record = ();
/// # type DbError = ();
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = Record;
/// # type Error = DbError;
/// # type Future = futures_util::future::Ready<Result<Record, DbError>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(()))
/// # }
/// # }
/// #
/// # fn main() {
/// // A service returning Result<Record, DbError>
/// let service = DatabaseService::new("127.0.0.1:8080");
///
/// // An async function that attempts to recover from errors returned by the
/// // database.
/// async fn recover_from_error(error: DbError) -> Result<Record, DbError> {
/// // ...
/// # Ok(())
/// }
/// # async {
///
/// // If the database service returns an error, attempt to recover by
/// // calling `recover_from_error`. Otherwise, return the successful response.
/// let mut new_service = service.then(|result| async move {
/// match result {
/// Ok(record) => Ok(record),
/// Err(e) => recover_from_error(e).await,
/// }
/// });
///
/// // Call the new service
/// let id = 13;
/// let record = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await?;
/// # Ok::<(), DbError>(())
/// # };
/// # }
/// ```
///
/// [`Future`]: crate::Service::Future
/// [`Output`]: std::future::Future::Output
/// [`futures` crate]: https://docs.rs/futures
/// [`FutureExt::then`]: https://docs.rs/futures/latest/futures/future/trait.FutureExt.html#method.then
/// [`Error`]: crate::Service::Error
/// [`Response`]: crate::Service::Response
/// [`poll_ready`]: crate::Service::poll_ready
/// [`BoxError`]: crate::BoxError
fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>
where
Self: Sized,
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,
{
Then::new(self, f)
}
/// Composes a function that transforms futures produced by the service.
///
/// This takes a function or closure returning a future computed from the future returned by
/// the service's [`call`] method, as opposed to the responses produced by the future.
///
/// # Examples
///
/// ```
/// # use std::task::{Poll, Context};
/// # use tower::{Service, ServiceExt, BoxError};
/// #
/// # struct DatabaseService;
/// # impl DatabaseService {
/// # fn new(address: &str) -> Self {
/// # DatabaseService
/// # }
/// # }
/// #
/// # type Record = ();
/// # type DbError = crate::BoxError;
/// #
/// # impl Service<u32> for DatabaseService {
/// # type Response = Record;
/// # type Error = DbError;
/// # type Future = futures_util::future::Ready<Result<Record, DbError>>;
/// #
/// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
/// # Poll::Ready(Ok(()))
/// # }
/// #
/// # fn call(&mut self, request: u32) -> Self::Future {
/// # futures_util::future::ready(Ok(()))
/// # }
/// # }
/// #
/// # fn main() {
/// use std::time::Duration;
/// use tokio::time::timeout;
///
/// // A service returning Result<Record, DbError>
/// let service = DatabaseService::new("127.0.0.1:8080");
/// # async {
///
/// let mut new_service = service.map_future(|future| async move {
/// let res = timeout(Duration::from_secs(1), future).await?;
/// Ok::<_, BoxError>(res)
/// });
///
/// // Call the new service
/// let id = 13;
/// let record = new_service
/// .ready()
/// .await?
/// .call(id)
/// .await?;
/// # Ok::<(), BoxError>(())
/// # };
/// # }
/// ```
///
/// Note that normally you wouldn't implement timeouts like this and instead use [`Timeout`].
///
/// [`call`]: crate::Service::call
/// [`Timeout`]: crate::timeout::Timeout
fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>
where
Self: Sized,
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,
{
MapFuture::new(self, f)
}
}
impl<T: ?Sized, Request> ServiceExt<Request> for T where T: tower_service::Service<Request> {}
/// Convert an `Option<Layer>` into a [`Layer`].
///
/// ```
/// # use std::time::Duration;
/// # use tower::Service;
/// # use tower::builder::ServiceBuilder;
/// use tower::util::option_layer;
/// # use tower::timeout::TimeoutLayer;
/// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send {
/// # let timeout = Some(Duration::new(10, 0));
/// // Layer to apply a timeout if configured
/// let maybe_timeout = option_layer(timeout.map(TimeoutLayer::new));
///
/// ServiceBuilder::new()
/// .layer(maybe_timeout)
/// .service(svc);
/// # }
/// ```
///
/// [`Layer`]: crate::layer::Layer
pub fn option_layer<L>(layer: Option<L>) -> Either<L, Identity> {
if let Some(layer) = layer {
Either::A(layer)
} else {
Either::B(Identity::new())
}
}