crux_http/command.rs
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
//! The Command based API for crux_http
use std::{fmt, future::Future, marker::PhantomData};
use crux_core::{command, Command};
use http_types::{
convert::DeserializeOwned,
headers::{HeaderName, ToHeaderValues},
Body, Method, Mime, Url,
};
use serde::Serialize;
use crate::{
expect::{ExpectBytes, ExpectJson, ExpectString, ResponseExpectation},
middleware::Middleware,
protocol::{HttpRequest, HttpResult, ProtocolRequestBuilder},
HttpError, Request, Response,
};
pub struct Http<Effect, Event> {
effect: PhantomData<Effect>,
event: PhantomData<Event>,
}
impl<Effect, Event> Http<Effect, Event>
where
Effect: Send + From<crux_core::Request<HttpRequest>> + 'static,
Event: Send + 'static,
{
/// Instruct the Shell to perform a HTTP GET request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<String>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::get("https://httpbin.org/get")
/// .expect_string()
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn get(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Get, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP HEAD request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::head("https://httpbin.org/get")
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn head(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Head, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP POST request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::post("https://httpbin.org/post")
/// .body_bytes(b"hello_world".to_owned())
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn post(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Post, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP PUT request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::put("https://httpbin.org/put")
/// .body_string("hello_world".to_string())
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn put(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Put, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP DELETE request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::delete("https://httpbin.org/delete")
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn delete(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Delete, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP PATCH request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::patch("https://httpbin.org/patch")
/// .body_form(&[("name", "Alice")]).unwrap()
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn patch(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Patch, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP OPTIONS request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::options("https://httpbin.org/get")
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn options(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Options, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP TRACE request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::trace("https://httpbin.org/get")
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn trace(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Trace, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform a HTTP CONNECT request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::connect("https://httpbin.org/get")
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn connect(url: impl AsRef<str>) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(Method::Connect, url.as_ref().parse().unwrap())
}
/// Instruct the Shell to perform an HTTP request to the provided `url`.
///
/// The request can be configured via associated functions on the returned
/// [`RequestBuilder`] and then converted to a [`Command`]
/// with [`RequestBuilder::build`].
///
/// # Panics
///
/// This will panic if a malformed URL is passed.
///
/// # Examples
///
/// ```
/// # use http_types::Method;
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::request(Method::Post, "https://httpbin.org/post".parse().unwrap())
/// .body_form(&[("name", "Alice")]).unwrap()
/// .build()
/// .then_send(Event::ReceiveResponse);
pub fn request(method: Method, url: Url) -> RequestBuilder<Effect, Event> {
RequestBuilder::new(method, url)
}
}
/// Request Builder
///
/// Provides an ergonomic way to chain the creation of a request.
/// This is generally accessed as the return value from
/// `crux_http::command::Http::{method}()`.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::post("https://httpbin.org/post")
/// .body("<html>hi</html>")
/// .header("custom-header", "value")
/// .content_type(crux_http::http::mime::HTML)
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
#[must_use]
pub struct RequestBuilder<Effect, Event, ExpectBody = Vec<u8>> {
/// Holds the state of the request.
req: Option<Request>,
effect: PhantomData<Effect>,
event: PhantomData<fn() -> Event>,
expectation: Box<dyn ResponseExpectation<Body = ExpectBody> + Send>,
}
impl<Effect, Event> RequestBuilder<Effect, Event, Vec<u8>>
where
Effect: Send + From<crux_core::Request<HttpRequest>> + 'static,
Event: 'static,
{
pub(crate) fn new(method: Method, url: Url) -> Self {
Self {
req: Some(Request::new(method, url)),
effect: PhantomData,
event: PhantomData,
expectation: Box::new(ExpectBytes),
}
}
}
impl<Effect, Event, ExpectBody> RequestBuilder<Effect, Event, ExpectBody>
where
Effect: Send + From<crux_core::Request<HttpRequest>> + 'static,
Event: Send + 'static,
ExpectBody: 'static,
{
/// Sets a header on the request.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::get("https://httpbin.org/get")
/// .body("<html>hi</html>")
/// .header("header-name", "header-value")
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn header(mut self, key: impl Into<HeaderName>, value: impl ToHeaderValues) -> Self {
self.req.as_mut().unwrap().insert_header(key, value);
self
}
/// Sets the Content-Type header on the request.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::get("https://httpbin.org/get")
/// .content_type(crux_http::http::mime::HTML)
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn content_type(mut self, content_type: impl Into<Mime>) -> Self {
self.req
.as_mut()
.unwrap()
.set_content_type(content_type.into());
self
}
/// Sets the body of the request from any type with implements `Into<Body>`, for example, any type with is `AsyncRead`.
/// # Mime
///
/// The encoding is set to `application/octet-stream`.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::post("https://httpbin.org/post")
/// .body(serde_json::json!({"any": "Into<Body>"}))
/// .content_type(crux_http::http::mime::HTML)
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn body(mut self, body: impl Into<Body>) -> Self {
self.req.as_mut().unwrap().set_body(body);
self
}
/// Pass JSON as the request body.
///
/// # Mime
///
/// The encoding is set to `application/json`.
///
/// # Errors
///
/// This method will return an error if the provided data could not be serialized to JSON.
///
/// # Examples
///
/// ```
/// # use serde::{Deserialize, Serialize};
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// #[derive(Deserialize, Serialize)]
/// struct Ip {
/// ip: String
/// }
///
/// let data = &Ip { ip: "129.0.0.1".into() };
/// Http::post("https://httpbin.org/post")
/// .body_json(data)
/// .expect("could not serialize body")
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn body_json(self, json: &impl Serialize) -> crate::Result<Self> {
Ok(self.body(Body::from_json(json)?))
}
/// Pass a string as the request body.
///
/// # Mime
///
/// The encoding is set to `text/plain; charset=utf-8`.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::post("https://httpbin.org/post")
/// .body_string("hello_world".to_string())
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn body_string(self, string: String) -> Self {
self.body(Body::from_string(string))
}
/// Pass bytes as the request body.
///
/// # Mime
///
/// The encoding is set to `application/octet-stream`.
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::post("https://httpbin.org/post")
/// .body_bytes(b"hello_world".to_owned())
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn body_bytes(self, bytes: impl AsRef<[u8]>) -> Self {
self.body(Body::from(bytes.as_ref()))
}
/// Pass form data as the request body. The form data needs to be
/// serializable to name-value pairs.
///
/// # Mime
///
/// The `content-type` is set to `application/x-www-form-urlencoded`.
///
/// # Errors
///
/// An error will be returned if the provided data cannot be serialized to
/// form data.
///
/// # Examples
///
/// ```
/// # use std::collections::HashMap;
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// let form_data = HashMap::from([
/// ("name", "Alice"),
/// ("location", "UK"),
/// ]);
/// Http::post("https://httpbin.org/post")
/// .body_form(&form_data)
/// .expect("could not serialize body")
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn body_form(self, form: &impl Serialize) -> crate::Result<Self> {
Ok(self.body(Body::from_form(form)?))
}
/// Set the URL querystring.
///
/// # Examples
///
/// ```
/// # use serde::{Deserialize, Serialize};
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// #[derive(Serialize, Deserialize)]
/// struct Index {
/// page: u32
/// }
///
/// let query = Index { page: 2 };
/// Http::post("https://httpbin.org/post")
/// .query(&query)
/// .expect("could not serialize query string")
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn query(mut self, query: &impl Serialize) -> std::result::Result<Self, HttpError> {
self.req.as_mut().unwrap().set_query(query)?;
Ok(self)
}
/// Push middleware onto a per-request middleware stack.
///
/// **Important**: Setting per-request middleware incurs extra allocations.
/// Creating a `Client` with middleware is recommended.
///
/// Client middleware is run before per-request middleware.
///
/// See the [middleware] submodule for more information on middleware.
///
/// [middleware]: ../middleware/index.html
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Vec<u8>>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::get("https://httpbin.org/redirect/2")
/// .middleware(crux_http::middleware::Redirect::default())
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn middleware(mut self, middleware: impl Middleware) -> Self {
self.req.as_mut().unwrap().middleware(middleware);
self
}
/// Return the constructed `Request` in a [`crux_core::command::RequestBuilder`].
pub fn build(
self,
) -> command::RequestBuilder<
Effect,
Event,
impl Future<Output = Result<Response<ExpectBody>, HttpError>>,
> {
let req = self.req.expect("RequestBuilder::build called twice");
command::RequestBuilder::new(|ctx| async move {
let operation = req
.into_protocol_request()
.await
.expect("should be able to convert request to protocol request");
let result = Command::request_from_shell(operation)
.into_future(ctx)
.await;
match result {
HttpResult::Ok(response) => Response::<Vec<u8>>::new(response.into())
.await
.and_then(|r| self.expectation.decode(r)),
HttpResult::Err(error) => Err(error),
}
})
}
/// Decode a String from the response body prior to dispatching it to the apps `update`
/// function.
///
/// This has no effect when used with the [async API](RequestBuilder::send_async).
///
/// # Examples
///
/// ```
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<String>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// Http::post("https://httpbin.org/json")
/// .expect_string()
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn expect_string(self) -> RequestBuilder<Effect, Event, String> {
let expectation = Box::<ExpectString>::default();
RequestBuilder {
req: self.req,
effect: PhantomData,
event: PhantomData,
expectation,
}
}
/// Decode a `T` from a JSON response body prior to dispatching it to the apps `update`
/// function.
///
/// # Examples
///
/// ```
/// # use serde::{Deserialize, Serialize};
/// # enum Event { ReceiveResponse(crux_http::Result<crux_http::Response<Slideshow>>) }
/// # #[derive(crux_core::macros::Effect)]
/// # #[allow(unused)]
/// # struct Capabilities { http: crux_http::Http<Event> }
/// # type Http = crux_http::command::Http<Effect, Event>;
/// #[derive(Deserialize)]
/// struct Response {
/// slideshow: Slideshow
/// }
///
/// #[derive(Deserialize)]
/// struct Slideshow {
/// author: String
/// }
///
/// Http::post("https://httpbin.org/json")
/// .expect_json::<Slideshow>()
/// .build()
/// .then_send(Event::ReceiveResponse);
/// ```
pub fn expect_json<T>(self) -> RequestBuilder<Effect, Event, T>
where
T: DeserializeOwned + 'static,
{
let expectation = Box::<ExpectJson<T>>::default();
RequestBuilder {
req: self.req,
effect: PhantomData,
event: PhantomData,
expectation,
}
}
}
impl<Effect, Event> fmt::Debug for RequestBuilder<Effect, Event> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&self.req, f)
}
}