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
//! # A GraphQL server library implemented in Rust //! //! <div align="center"> //! <!-- CI --> //! <img src="https://github.com/async-graphql/async-graphql/workflows/CI/badge.svg" /> //! <!-- codecov --> // <img src="https://codecov.io/gh/async-graphql/async-graphql/branch/master/graph/badge.svg" /> //! <!-- Crates version --> //! <a href="https://crates.io/crates/async-graphql"> //! <img src="https://img.shields.io/crates/v/async-graphql.svg?style=flat-square" //! alt="Crates.io version" /> //! </a> //! <!-- Downloads --> //! <a href="https://crates.io/crates/async-graphql"> //! <img src="https://img.shields.io/crates/d/async-graphql.svg?style=flat-square" //! alt="Download" /> //! </a> //! <!-- docs.rs docs --> //! <a href="https://docs.rs/async-graphql"> //! <img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square" //! alt="docs.rs docs" /> //! </a> //! </div> //! //! ## Documentation //! //! * [Feature Comparison](feature-comparison.md) //! * [Book](https://async-graphql.github.io/async-graphql/en/index.html) //! * [中文文档](https://async-graphql.github.io/async-graphql/zh-CN/index.html) //! * [Docs](https://docs.rs/async-graphql) //! * [GitHub repository](https://github.com/async-graphql/async-graphql) //! * [Cargo package](https://crates.io/crates/async-graphql) //! * Minimum supported Rust version: 1.42 or later //! //! ## Features //! //! * Fully supports async/await //! * Type safety //! * Rustfmt friendly (Procedural Macro) //! * Custom scalars //! * Minimal overhead //! * Easy integration (hyper, actix_web, tide ...) //! * File upload (Multipart request) //! * Subscriptions (WebSocket transport) //! * Custom extensions //! * Apollo Tracing extension //! * Limit query complexity/depth //! * Error Extensions //! * Apollo Federation //! //! ## Integrations //! //! * Actix-web [async-graphql-actix_web](https://crates.io/crates/async-graphql-actix-web) //! * Warp [async-graphql-warp](https://crates.io/crates/async-graphql-warp) //! * Tide [async-graphql-tide](https://crates.io/crates/async-graphql-tide) //! //! ## License //! //! Licensed under either of //! //! * Apache License, Version 2.0, //! (./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) //! * MIT license (./LICENSE-MIT or http://opensource.org/licenses/MIT) //! at your option. //! //! ## References //! //! * [GraphQL](https://graphql.org) //! * [GraphQL Multipart Request](https://github.com/jaydenseric/graphql-multipart-request-spec) //! * [GraphQL Cursor Connections Specification](https://facebook.github.io/relay/graphql/connections.htm) //! * [GraphQL over WebSocket Protocol](https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md) //! * [Apollo Tracing](https://github.com/apollographql/apollo-tracing) //! * [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/introduction) //! //! ## Examples //! //! If you are just getting started, we recommend checking out our examples at: //! [https://github.com/async-graphql/examples](https://github.com/async-graphql/examples) //! //! To see how you would create a Relay-compliant server using async-graphql, warp, diesel & postgresql, you can also check out a real-world example at: //! [https://github.com/phated/twentyfive-stars](https://github.com/phated/twentyfive-stars) //! //! ## Benchmarks //! //! Ensure that there is no CPU-heavy process in background! //! //! ```shell script //! cd benchmark //! cargo bench //! ``` //! //! Now a HTML report is available at `benchmark/target/criterion/report`. //! #![warn(missing_docs)] #![allow(clippy::needless_lifetimes)] #![allow(clippy::trivially_copy_pass_by_ref)] #![recursion_limit = "256"] #![forbid(unsafe_code)] mod base; mod context; mod error; mod look_ahead; mod model; mod mutation_resolver; mod query; mod resolver; mod scalars; mod schema; mod subscription; mod types; mod validation; pub mod extensions; pub mod guard; pub mod validators; #[doc(hidden)] pub use async_graphql_parser as parser; #[doc(hidden)] pub use anyhow; #[doc(hidden)] pub use async_trait; #[doc(hidden)] pub use futures; #[doc(hidden)] pub use indexmap; #[doc(hidden)] pub use serde_json; pub mod http; pub use base::{ScalarType, Type}; pub use context::{ Context, ContextBase, Data, QueryEnv, QueryPathNode, QueryPathSegment, Variables, }; pub use error::{ Error, ErrorExtensions, FieldError, FieldResult, InputValueError, InputValueResult, ParseRequestError, QueryError, ResultExt, RuleError, }; pub use look_ahead::Lookahead; pub use parser::{types::ConstValue as Value, Pos, Positioned}; pub use query::{IntoQueryBuilder, IntoQueryBuilderOpts, QueryBuilder, QueryResponse}; pub use registry::CacheControl; pub use scalars::{Any, Json, OutputJson, ID}; pub use schema::{Schema, SchemaBuilder, SchemaEnv}; pub use serde_json::Number; pub use subscription::{ ConnectionTransport, SimpleBroker, SubscriptionStreams, WebSocketTransport, }; pub use types::{ connection, EmptyMutation, EmptySubscription, MaybeUndefined, MergedObject, MergedObjectSubscriptionTail, MergedObjectTail, Upload, }; pub use validation::ValidationMode; /// Result type pub type Result<T> = std::result::Result<T, Error>; // internal types #[doc(hidden)] pub use context::ContextSelectionSet; #[doc(hidden)] pub mod registry; #[doc(hidden)] pub use base::{BoxFieldFuture, InputObjectType, InputValueType, ObjectType, OutputValueType}; #[doc(hidden)] pub use resolver::{collect_fields, do_resolve}; #[doc(hidden)] pub use subscription::SubscriptionType; #[doc(hidden)] pub use types::{EnumItem, EnumType}; /// Define a GraphQL object with methods /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_complex_object.html).* /// /// All methods are converted to camelCase. /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |---------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// | extends | Add fields to an entity that's defined in another service | bool | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |---------------|---------------------------|----------|----------| /// | name | Field name | string | Y | /// | desc | Field description | string | Y | /// | deprecation | Field deprecation reason | string | Y | /// | cache_control | Field cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// | external | Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field. | bool | Y | /// | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | /// | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | /// | guard | Field of guard | [`Guard`](guard/trait.Guard.html) | Y | /// | feature | It's like a `#[cfg(feature = "foo")]` attribute but instead of not compiling this field it will just return a proper `FieldError` to tell you this feature is not enabled | string ("feature1,feature2") | Y | /// /// # Field argument parameters /// /// | Attribute | description | Type | Optional | /// |--------------|------------------------------------------|------------ |----------| /// | name | Argument name | string | Y | /// | desc | Argument description | string | Y | /// | default | Use `Default::default` for default value | none | Y | /// | default | Argument default value | literal | Y | /// | default_with | Expression to generate default value | code string | Y | /// | validator | Input value validator | [`InputValueValidator`](validators/trait.InputValueValidator.html) | Y | /// /// # Valid field return types /// /// - Scalar values, such as `i32` and `bool`. `usize`, `isize`, `u128` and `i128` are not /// supported /// - `Vec<T>`, such as `Vec<i32>` /// - Slices, such as `&[i32]` /// - `Option<T>`, such as `Option<i32>` /// - GraphQL objects. /// - GraphQL enums. /// - References to any of the above types, such as `&i32` or `&Option<String>`. /// - `FieldResult<T, E>`, such as `FieldResult<i32, E>` /// /// # Context /// /// You can define a context as an argument to a method, and the context should be the first argument to the method. /// /// ```ignore /// #[Object] /// impl QueryRoot { /// async fn value(&self, ctx: &Context<'_>) -> { ... } /// } /// ``` /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// struct QueryRoot { /// value: i32, /// } /// /// #[Object] /// impl QueryRoot { /// #[field(desc = "value")] /// async fn value(&self) -> i32 { /// self.value /// } /// /// #[field(desc = "reference value")] /// async fn value_ref(&self) -> &i32 { /// &self.value /// } /// /// #[field(desc = "value with error")] /// async fn value_with_error(&self) -> FieldResult<i32> { /// Ok(self.value) /// } /// /// async fn value_with_arg(&self, #[arg(default = 1)] a: i32) -> i32 { /// a /// } /// } /// /// async_std::task::block_on(async move { /// let schema = Schema::new(QueryRoot { value: 10 }, EmptyMutation, EmptySubscription); /// let res = schema.execute(r#"{ /// value /// valueRef /// valueWithError /// valueWithArg1: valueWithArg /// valueWithArg2: valueWithArg(a: 99) /// }"#).await.unwrap().data; /// assert_eq!(res, serde_json::json!({ /// "value": 10, /// "valueRef": 10, /// "valueWithError": 10, /// "valueWithArg1": 1, /// "valueWithArg2": 99 /// })); /// }); /// ``` pub use async_graphql_derive::Object; /// Define a GraphQL object with fields /// /// You can also [derive this](derive.GQLSimpleObject.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_simple_object.html).* /// /// Similar to `Object`, but defined on a structure that automatically generates getters for all fields. For a list of valid field types, see [`Object`](attr.Object.html). All fields are converted to camelCase. /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |---------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |---------------|---------------------------|----------|----------| /// | name | Field name | string | Y | /// | desc | Field description | string | Y | /// | deprecation | Field deprecation reason | string | Y | /// | owned | Field resolver return a ownedship value | bool | Y | /// | cache_control | Field cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// | external | Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field. | bool | Y | /// | provides | Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway. | string | Y | /// | requires | Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services. | string | Y | /// | guard | Field of guard | [`Guard`](guard/trait.Guard.html) | Y | /// | feature | It's like a `#[cfg(feature = "foo")]` attribute but instead of not compiling this field it will just return a proper `FieldError` to tell you this feature is not enabled | string ("feature1,feature2") | Y | /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// #[SimpleObject] /// struct QueryRoot { /// value: i32, /// } /// /// async_std::task::block_on(async move { /// let schema = Schema::new(QueryRoot{ value: 10 }, EmptyMutation, EmptySubscription); /// let res = schema.execute("{ value }").await.unwrap().data; /// assert_eq!(res, serde_json::json!({ /// "value": 10, /// })); /// }); /// ``` pub use async_graphql_derive::SimpleObject; /// Derive a GraphQL enum /// /// You can also [use an attribute](attr.Enum.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_enum.html).* /// /// All variants are converted to SCREAMING_SNAKE_CASE. /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// #[derive(GQLEnum, Eq, PartialEq, Copy, Clone)] /// #[graphql(name = "Enum1")] /// enum MyEnum { /// One, /// Two, /// } /// ``` pub use async_graphql_derive::GQLEnum; /// Derive a GraphQL input object /// /// You can also [use an attribute](attr.InputObject.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_input_object.html).* /// /// # Examples /// /// ```rust /// use async_graphql::*; /// #[derive(GQLInputObject)] /// #[graphql(name = "MyInput1")] /// struct MyInput { /// value: i32, /// } /// ``` pub use async_graphql_derive::GQLInputObject; /// Derive a GraphQL object with fields /// /// You can also [use an attribute](attr.SimpleObject.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_simple_object.html).* /// /// # Examples /// /// ```rust /// use async_graphql::*; /// #[derive(GQLSimpleObject)] /// #[graphql(name = "MyObj1")] /// struct MyObj { /// value: i32, /// } /// ``` pub use async_graphql_derive::GQLSimpleObject; /// Define a GraphQL enum /// /// You can also [derive this](derive.GQLEnum.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_enum.html).* /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Enum name | string | Y | /// | desc | Enum description | string | Y | /// /// # Item parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Item name | string | Y | /// | desc | Item description | string | Y | /// | deprecation | Item deprecation reason | string | Y | /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// #[Enum] /// enum MyEnum { /// A, /// #[item(name = "b")] B, /// } /// /// struct QueryRoot { /// value1: MyEnum, /// value2: MyEnum, /// } /// /// #[Object] /// impl QueryRoot { /// #[field(desc = "value")] /// async fn value1(&self) -> MyEnum { /// self.value1 /// } /// /// #[field(desc = "value")] /// async fn value2(&self) -> MyEnum { /// self.value2 /// } /// } /// /// async_std::task::block_on(async move { /// let schema = Schema::new(QueryRoot{ value1: MyEnum::A, value2: MyEnum::B }, EmptyMutation, EmptySubscription); /// let res = schema.execute("{ value1 value2 }").await.unwrap().data; /// assert_eq!(res, serde_json::json!({ "value1": "A", "value2": "b" })); /// }); /// ``` pub use async_graphql_derive::Enum; /// Define a GraphQL input object /// /// You can also [derive this](derive.GQLInputObject.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_input_object.html).* /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |--------------|------------------------------------------|----------|----------| /// | name | Field name | string | Y | /// | desc | Field description | string | Y | /// | default | Use `Default::default` for default value | none | Y | /// | default | Argument default value | literal | Y | /// | default_with | Expression to generate default value | code string | Y | /// | validator | Input value validator | [`InputValueValidator`](validators/trait.InputValueValidator.html) | Y | /// | flatten | Similar to serde (flatten) | boolean | Y | /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// #[InputObject] /// struct MyInputObject { /// a: i32, /// #[field(default = 10)] /// b: i32, /// } /// /// struct QueryRoot; /// /// #[Object] /// impl QueryRoot { /// #[field(desc = "value")] /// async fn value(&self, input: MyInputObject) -> i32 { /// input.a * input.b /// } /// } /// /// async_std::task::block_on(async move { /// let schema = Schema::new(QueryRoot, EmptyMutation, EmptySubscription); /// let res = schema.execute(r#" /// { /// value1: value(input:{a:9, b:3}) /// value2: value(input:{a:9}) /// }"#).await.unwrap().data; /// assert_eq!(res, serde_json::json!({ "value1": 27, "value2": 90 })); /// }); /// ``` pub use async_graphql_derive::InputObject; /// Define a GraphQL interface /// /// You can also [derive this](derive.GQLInterface.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_interface.html).* /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Field name | string | N | /// | method | Rust resolver method name. If specified, `name` will not be camelCased in schema definition | string | Y | /// | type | Field type | string | N | /// | desc | Field description | string | Y | /// | deprecation | Field deprecation reason | string | Y | /// | args | Field arguments | | Y | /// /// # Field argument parameters /// /// | Attribute | description | Type | Optional | /// |--------------|------------------------------------------|-------------|----------| /// | name | Argument name | string | N | /// | type | Argument type | string | N | /// | desc | Argument description | string | Y | /// | default | Use `Default::default` for default value | none | Y | /// | default | Argument default value | literal | Y | /// | default_with | Expression to generate default value | code string | Y | /// /// # Define an interface /// /// Define TypeA, TypeB, TypeC... Implement the MyInterface /// /// ```ignore /// #[Interface] /// enum MyInterface { /// TypeA(TypeA), /// TypeB(TypeB), /// TypeC(TypeC), /// ... /// } /// ``` /// /// # Fields /// /// The type, name, and parameter fields of the interface must exactly match the type of the /// implementation interface, but FieldResult can be omitted. /// /// ```rust /// use async_graphql::*; /// /// struct TypeA { /// value: i32, /// } /// /// #[Object] /// impl TypeA { /// /// Returns data borrowed from the context /// async fn value_a<'a>(&self, ctx: &'a Context<'_>) -> FieldResult<&'a str> { /// Ok(ctx.data::<String>()?.as_str()) /// } /// /// /// Returns data borrowed self /// async fn value_b(&self) -> &i32 { /// &self.value /// } /// /// /// With parameters /// async fn value_c(&self, a: i32, b: i32) -> i32 { /// a + b /// } /// /// /// Disabled name transformation, don't forget "method" argument in interface! /// #[field(name = "value_d")] /// async fn value_d(&self) -> i32 { /// &self.value + 1 /// } /// } /// /// #[Interface( /// field(name = "value_a", type = "&'ctx str"), /// field(name = "value_b", type = "&i32"), /// field(name = "value_c", type = "i32", /// arg(name = "a", type = "i32"), /// arg(name = "b", type = "i32")), /// field(name = "value_d", method = "value_d", type = "i32"), /// )] /// enum MyInterface { /// TypeA(TypeA) /// } /// /// struct QueryRoot; /// /// #[Object] /// impl QueryRoot { /// async fn type_a(&self) -> MyInterface { /// TypeA { value: 10 }.into() /// } /// } /// /// async_std::task::block_on(async move { /// let schema = Schema::build(QueryRoot, EmptyMutation, EmptySubscription).data("hello".to_string()).finish(); /// let res = schema.execute(r#" /// { /// typeA { /// valueA /// valueB /// valueC(a: 3, b: 2) /// value_d /// } /// }"#).await.unwrap().data; /// assert_eq!(res, serde_json::json!({ /// "typeA": { /// "valueA": "hello", /// "valueB": 10, /// "valueC": 5, /// "value_d": 11 /// } /// })); /// }); /// ``` pub use async_graphql_derive::Interface; /// Derive a GraphQL interface /// /// You can also [use an attribute](attr.Interface.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_interface.html).* pub use async_graphql_derive::GQLInterface; /// Define a GraphQL union /// /// You can also [derive this](derive.GQLUnion.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_union.html).* /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Define a union /// /// Define TypeA, TypeB, ... as MyUnion /// /// ```rust /// use async_graphql::*; /// /// #[SimpleObject] /// struct TypeA { /// value_a: i32, /// } /// /// #[SimpleObject] /// struct TypeB { /// value_b: i32 /// } /// /// #[Union] /// enum MyUnion { /// TypeA(TypeA), /// TypeB(TypeB), /// } /// /// struct QueryRoot; /// /// #[Object] /// impl QueryRoot { /// async fn all_data(&self) -> Vec<MyUnion> { /// vec![TypeA { value_a: 10 }.into(), TypeB { value_b: 20 }.into()] /// } /// } /// /// async_std::task::block_on(async move { /// let schema = Schema::build(QueryRoot, EmptyMutation, EmptySubscription).data("hello".to_string()).finish(); /// let res = schema.execute(r#" /// { /// allData { /// ... on TypeA { /// valueA /// } /// ... on TypeB { /// valueB /// } /// } /// }"#).await.unwrap().data; /// assert_eq!(res, serde_json::json!({ /// "allData": [ /// { "valueA": 10 }, /// { "valueB": 20 }, /// ] /// })); /// }); /// ``` pub use async_graphql_derive::Union; /// Derive a GraphQL union /// /// You can also [use an attribute](attr.Union.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/define_union.html).* pub use async_graphql_derive::GQLUnion; /// Define a GraphQL subscription /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/subscription.html).* /// /// The field function is a synchronization function that performs filtering. When true is returned, the message is pushed to the client. /// The second parameter is the type of the field. /// Starting with the third parameter is one or more filtering conditions, The filter condition is the parameter of the field. /// The filter function should be synchronous. /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Field parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Field name | string | Y | /// | desc | Field description | string | Y | /// | deprecation | Field deprecation reason | string | Y | /// | guard | Field of guard | [`Guard`](guard/trait.Guard.html) | Y | /// | feature | It's like a `#[cfg(feature = "foo")]` attribute but instead of not compiling this field it will just return a proper `FieldError` to tell you this feature is not enabled | string ("feature1,feature2") | Y | /// /// # Field argument parameters /// /// | Attribute | description | Type | Optional | /// |--------------|------------------------------------------|-------------|----------| /// | name | Argument name | string | Y | /// | desc | Argument description | string | Y | /// | default | Use `Default::default` for default value | none | Y | /// | default | Argument default value | literal | Y | /// | default_with | Expression to generate default value | code string | Y | /// | validator | Input value validator | [`InputValueValidator`](validators/trait.InputValueValidator.html) | Y | /// /// # Examples /// /// ```ignore /// use async_graphql::*; /// /// #[Object] /// struct Event { /// value: i32, /// } /// /// struct SubscriptionRoot; /// /// #[Subscription] /// impl SubscriptionRoot { /// async fn value(&self, event: &Event, condition: i32) -> bool { /// // Push when value is greater than condition /// event.value > condition /// } /// } /// ``` pub use async_graphql_derive::Subscription; /// Define a Scalar /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |-------------|---------------------------|----------|----------| /// | name | Scalar name | string | Y | /// | desc | Scalar description | string | Y | /// pub use async_graphql_derive::Scalar; /// Define a merged object with multiple object types. /// /// You can also [derive this](derive.GQLMergedObject.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/merging_objects.html).* /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |---------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// | cache_control | Object cache control | [`CacheControl`](struct.CacheControl.html) | Y | /// | extends | Add fields to an entity that's defined in another service | bool | Y | /// /// # Examples /// /// ```rust /// use async_graphql::*; /// /// #[SimpleObject] /// struct Object1 { /// a: i32, /// } /// /// #[SimpleObject] /// struct Object2 { /// b: i32, /// } /// /// #[SimpleObject] /// struct Object3 { /// c: i32, /// } /// /// #[MergedObject] /// struct MyObj(Object1, Object2, Object3); /// /// let obj = MyObj(Object1 { a: 10 }, Object2 { b: 20 }, Object3 { c: 30 }); /// ``` pub use async_graphql_derive::MergedObject; /// Derive a GraphQL Merged object /// /// You can also [use an attribute](attr.MergedObject.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/merging_objects.html).* pub use async_graphql_derive::GQLMergedObject; /// Define a merged subscription with multiple subscription types. /// /// You can also [derive this](derive.GQLMergedSubscription.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/merging_objects.html).* /// /// # Macro parameters /// /// | Attribute | description | Type | Optional | /// |---------------|---------------------------|----------|----------| /// | name | Object name | string | Y | /// | desc | Object description | string | Y | /// /// # Examples /// /// ```rust /// use async_graphql::*; /// use futures::Stream; /// /// #[derive(Default)] /// struct Subscription1; /// /// #[Subscription] /// impl Subscription1 { /// async fn events1(&self) -> impl Stream<Item = i32> { /// futures::stream::iter(0..10) /// } /// } /// /// #[derive(Default)] /// struct Subscription2; /// /// #[Subscription] /// impl Subscription2 { /// async fn events2(&self) -> impl Stream<Item = i32> { /// futures::stream::iter(10..20) /// } /// } /// /// #[derive(GQLMergedSubscription, Default)] /// struct Subscription(Subscription1, Subscription2); /// ``` pub use async_graphql_derive::MergedSubscription; /// Derive a GraphQL merged subscription with multiple subscription types. /// /// You can also [use an attribute](attr.MergedSubscription.html). /// /// *[See also the Book](https://async-graphql.github.io/async-graphql/en/merging_objects.html).* pub use async_graphql_derive::GQLMergedSubscription;