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 985 986 987 988 989 990 991 992 993
// DO NOT EDIT ! // This file was generated automatically from 'src/mako/api/lib.rs.mako' // DO NOT EDIT ! //! This documentation was generated from *pagespeedonline* crate version *1.0.10+20190507*, where *20190507* is the exact revision of the *pagespeedonline:v2* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.10*. //! //! Everything else about the *pagespeedonline* *v2* API can be found at the //! [official documentation site](https://developers.google.com/speed/docs/insights/v2/getting-started). //! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/pagespeedonline2). //! # Features //! //! Handle the following *Resources* with ease from the central [hub](struct.Pagespeedonline.html) ... //! //! * pagespeedapi //! * [*runpagespeed*](struct.PagespeedapiRunpagespeedCall.html) //! //! //! //! //! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](http://byron.github.io/google-apis-rs). //! //! # Structure of this Library //! //! The API is structured into the following primary items: //! //! * **[Hub](struct.Pagespeedonline.html)** //! * a central object to maintain state and allow accessing all *Activities* //! * creates [*Method Builders*](trait.MethodsBuilder.html) which in turn //! allow access to individual [*Call Builders*](trait.CallBuilder.html) //! * **[Resources](trait.Resource.html)** //! * primary types that you can apply *Activities* to //! * a collection of properties and *Parts* //! * **[Parts](trait.Part.html)** //! * a collection of properties //! * never directly used in *Activities* //! * **[Activities](trait.CallBuilder.html)** //! * operations to apply to *Resources* //! //! All *structures* are marked with applicable traits to further categorize them and ease browsing. //! //! Generally speaking, you can invoke *Activities* like this: //! //! ```Rust,ignore //! let r = hub.resource().activity(...).doit() //! ``` //! //! Or specifically ... //! //! ```ignore //! let r = hub.pagespeedapi().runpagespeed(...).doit() //! ``` //! //! The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities` //! supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be //! specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired. //! The `doit()` method performs the actual communication with the server and returns the respective result. //! //! # Usage //! //! ## Setting up your Project //! //! To use this library, you would put the following lines into your `Cargo.toml` file: //! //! ```toml //! [dependencies] //! google-pagespeedonline2 = "*" //! # This project intentionally uses an old version of Hyper. See //! # https://github.com/Byron/google-apis-rs/issues/173 for more //! # information. //! hyper = "^0.10" //! hyper-rustls = "^0.6" //! serde = "^1.0" //! serde_json = "^1.0" //! yup-oauth2 = "^1.0" //! ``` //! //! ## A complete example //! //! ```test_harness,no_run //! extern crate hyper; //! extern crate hyper_rustls; //! extern crate yup_oauth2 as oauth2; //! extern crate google_pagespeedonline2 as pagespeedonline2; //! use pagespeedonline2::{Result, Error}; //! # #[test] fn egal() { //! use std::default::Default; //! use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; //! use pagespeedonline2::Pagespeedonline; //! //! // Get an ApplicationSecret instance by some means. It contains the `client_id` and //! // `client_secret`, among other things. //! let secret: ApplicationSecret = Default::default(); //! // Instantiate the authenticator. It will choose a suitable authentication flow for you, //! // unless you replace `None` with the desired Flow. //! // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about //! // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and //! // retrieve them from storage. //! let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, //! hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), //! <MemoryStorage as Default>::default(), None); //! let mut hub = Pagespeedonline::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); //! // You can configure optional parameters by calling the respective setters at will, and //! // execute the final call using `doit()`. //! // Values shown here are possibly random and not representative ! //! let result = hub.pagespeedapi().runpagespeed("url") //! .strategy("accusam") //! .screenshot(true) //! .add_rule("justo") //! .locale("amet.") //! .filter_third_party_resources(false) //! .doit(); //! //! match result { //! Err(e) => match e { //! // The Error enum provides details about what exactly happened. //! // You can also just use its `Debug`, `Display` or `Error` traits //! Error::HttpError(_) //! |Error::MissingAPIKey //! |Error::MissingToken(_) //! |Error::Cancelled //! |Error::UploadSizeLimitExceeded(_, _) //! |Error::Failure(_) //! |Error::BadRequest(_) //! |Error::FieldClash(_) //! |Error::JsonDecodeError(_, _) => println!("{}", e), //! }, //! Ok(res) => println!("Success: {:?}", res), //! } //! # } //! ``` //! ## Handling Errors //! //! All errors produced by the system are provided either as [Result](enum.Result.html) enumeration as return value of //! the doit() methods, or handed as possibly intermediate results to either the //! [Hub Delegate](trait.Delegate.html), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html). //! //! When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This //! makes the system potentially resilient to all kinds of errors. //! //! ## Uploads and Downloads //! If a method supports downloads, the response body, which is part of the [Result](enum.Result.html), should be //! read by you to obtain the media. //! If such a method also supports a [Response Result](trait.ResponseResult.html), it will return that by default. //! You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making //! this call: `.param("alt", "media")`. //! //! Methods supporting uploads can do so using up to 2 different protocols: //! *simple* and *resumable*. The distinctiveness of each is represented by customized //! `doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively. //! //! ## Customization and Callbacks //! //! You may alter the way an `doit()` method is called by providing a [delegate](trait.Delegate.html) to the //! [Method Builder](trait.CallBuilder.html) before making the final `doit()` call. //! Respective methods will be called to provide progress information, as well as determine whether the system should //! retry on failure. //! //! The [delegate trait](trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. //! //! ## Optional Parts in Server-Requests //! //! All structures provided by this library are made to be [enocodable](trait.RequestValue.html) and //! [decodable](trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses //! are valid. //! Most optionals are are considered [Parts](trait.Part.html) which are identifiable by name, which will be sent to //! the server to indicate either the set parts of the request or the desired parts in the response. //! //! ## Builder Arguments //! //! Using [method builders](trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. //! These will always take a single argument, for which the following statements are true. //! //! * [PODs][wiki-pod] are handed by copy //! * strings are passed as `&str` //! * [request values](trait.RequestValue.html) are moved //! //! Arguments will always be copied or cloned into the builder, to make them independent of their original life times. //! //! [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure //! [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern //! [google-go-api]: https://github.com/google/google-api-go-client //! //! // Unused attributes happen thanks to defined, but unused structures // We don't warn about this, as depending on the API, some data structures or facilities are never used. // Instead of pre-determining this, we just disable the lint. It's manually tuned to not have any // unused imports in fully featured APIs. Same with unused_mut ... . #![allow(unused_imports, unused_mut, dead_code)] // DO NOT EDIT ! // This file was generated automatically from 'src/mako/api/lib.rs.mako' // DO NOT EDIT ! #[macro_use] extern crate serde_derive; extern crate hyper; extern crate serde; extern crate serde_json; extern crate yup_oauth2 as oauth2; extern crate mime; extern crate url; mod cmn; use std::collections::HashMap; use std::cell::RefCell; use std::borrow::BorrowMut; use std::default::Default; use std::collections::BTreeMap; use serde_json as json; use std::io; use std::fs; use std::mem; use std::thread::sleep; use std::time::Duration; pub use cmn::*; // ############## // UTILITIES ### // ############ // ######## // HUB ### // ###### /// Central instance to access all Pagespeedonline related resource activities /// /// # Examples /// /// Instantiate a new hub /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate yup_oauth2 as oauth2; /// extern crate google_pagespeedonline2 as pagespeedonline2; /// use pagespeedonline2::{Result, Error}; /// # #[test] fn egal() { /// use std::default::Default; /// use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// use pagespeedonline2::Pagespeedonline; /// /// // Get an ApplicationSecret instance by some means. It contains the `client_id` and /// // `client_secret`, among other things. /// let secret: ApplicationSecret = Default::default(); /// // Instantiate the authenticator. It will choose a suitable authentication flow for you, /// // unless you replace `None` with the desired Flow. /// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about /// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and /// // retrieve them from storage. /// let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// <MemoryStorage as Default>::default(), None); /// let mut hub = Pagespeedonline::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.pagespeedapi().runpagespeed("url") /// .strategy("sea") /// .screenshot(false) /// .add_rule("dolores") /// .locale("gubergren") /// .filter_third_party_resources(false) /// .doit(); /// /// match result { /// Err(e) => match e { /// // The Error enum provides details about what exactly happened. /// // You can also just use its `Debug`, `Display` or `Error` traits /// Error::HttpError(_) /// |Error::MissingAPIKey /// |Error::MissingToken(_) /// |Error::Cancelled /// |Error::UploadSizeLimitExceeded(_, _) /// |Error::Failure(_) /// |Error::BadRequest(_) /// |Error::FieldClash(_) /// |Error::JsonDecodeError(_, _) => println!("{}", e), /// }, /// Ok(res) => println!("Success: {:?}", res), /// } /// # } /// ``` pub struct Pagespeedonline<C, A> { client: RefCell<C>, auth: RefCell<A>, _user_agent: String, _base_url: String, _root_url: String, } impl<'a, C, A> Hub for Pagespeedonline<C, A> {} impl<'a, C, A> Pagespeedonline<C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { pub fn new(client: C, authenticator: A) -> Pagespeedonline<C, A> { Pagespeedonline { client: RefCell::new(client), auth: RefCell::new(authenticator), _user_agent: "google-api-rust-client/1.0.10".to_string(), _base_url: "https://www.googleapis.com/pagespeedonline/v2/".to_string(), _root_url: "https://www.googleapis.com/".to_string(), } } pub fn pagespeedapi(&'a self) -> PagespeedapiMethods<'a, C, A> { PagespeedapiMethods { hub: &self } } /// Set the user-agent header field to use in all requests to the server. /// It defaults to `google-api-rust-client/1.0.10`. /// /// Returns the previously set user-agent. pub fn user_agent(&mut self, agent_name: String) -> String { mem::replace(&mut self._user_agent, agent_name) } /// Set the base url to use in all requests to the server. /// It defaults to `https://www.googleapis.com/pagespeedonline/v2/`. /// /// Returns the previously set base url. pub fn base_url(&mut self, new_base_url: String) -> String { mem::replace(&mut self._base_url, new_base_url) } /// Set the root url to use in all requests to the server. /// It defaults to `https://www.googleapis.com/`. /// /// Returns the previously set root url. pub fn root_url(&mut self, new_root_url: String) -> String { mem::replace(&mut self._root_url, new_root_url) } } // ############ // SCHEMAS ### // ########## /// Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct PagespeedApiFormatStringV2ArgsSecondaryRects { /// The width of the rect. pub width: Option<i32>, /// The top coordinate of the rect, in page coordinates. pub top: Option<i32>, /// The height of the rect. pub height: Option<i32>, /// The left coordinate of the rect, in page coordinates. pub left: Option<i32>, } impl NestedType for PagespeedApiFormatStringV2ArgsSecondaryRects {} impl Part for PagespeedApiFormatStringV2ArgsSecondaryRects {} /// The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct PagespeedApiFormatStringV2ArgsRects { /// The width of the rect. pub width: Option<i32>, /// The top coordinate of the rect, in page coordinates. pub top: Option<i32>, /// The height of the rect. pub height: Option<i32>, /// The left coordinate of the rect, in page coordinates. pub left: Option<i32>, } impl NestedType for PagespeedApiFormatStringV2ArgsRects {} impl Part for PagespeedApiFormatStringV2ArgsRects {} /// There is no detailed description. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct PagespeedApiFormatStringV2 { /// List of arguments for the format string. pub args: Option<Vec<PagespeedApiFormatStringV2Args>>, /// A localized format string with {{FOO}} placeholders, where 'FOO' is the key of the argument whose value should be substituted. For HYPERLINK arguments, the format string will instead contain {{BEGIN_FOO}} and {{END_FOO}} for the argument with key 'FOO'. pub format: Option<String>, } impl Part for PagespeedApiFormatStringV2 {} /// List of entries that provide information about URLs in the url block. Optional. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultFormattedResultsRuleResultsUrlBlocksUrls { /// List of entries that provide additional details about a single URL. Optional. pub details: Option<Vec<PagespeedApiFormatStringV2>>, /// A format string that gives information about the URL, and a list of arguments for that format string. pub result: Option<PagespeedApiFormatStringV2>, } impl NestedType for ResultFormattedResultsRuleResultsUrlBlocksUrls {} impl Part for ResultFormattedResultsRuleResultsUrlBlocksUrls {} /// Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultPageStats { /// Number of response bytes for flash resources on the page. #[serde(rename="flashResponseBytes")] pub flash_response_bytes: Option<String>, /// Total size of all request bytes sent by the page. #[serde(rename="totalRequestBytes")] pub total_request_bytes: Option<String>, /// Number of CSS resources referenced by the page. #[serde(rename="numberCssResources")] pub number_css_resources: Option<i32>, /// Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page. #[serde(rename="textResponseBytes")] pub text_response_bytes: Option<String>, /// Number of HTTP resources loaded by the page. #[serde(rename="numberResources")] pub number_resources: Option<i32>, /// Number of response bytes for other resources on the page. #[serde(rename="otherResponseBytes")] pub other_response_bytes: Option<String>, /// Number of response bytes for image resources on the page. #[serde(rename="imageResponseBytes")] pub image_response_bytes: Option<String>, /// Number of unique hosts referenced by the page. #[serde(rename="numberHosts")] pub number_hosts: Option<i32>, /// Number of uncompressed response bytes for JS resources on the page. #[serde(rename="javascriptResponseBytes")] pub javascript_response_bytes: Option<String>, /// Number of uncompressed response bytes for the main HTML document and all iframes on the page. #[serde(rename="htmlResponseBytes")] pub html_response_bytes: Option<String>, /// Number of uncompressed response bytes for CSS resources on the page. #[serde(rename="cssResponseBytes")] pub css_response_bytes: Option<String>, /// Number of JavaScript resources referenced by the page. #[serde(rename="numberJsResources")] pub number_js_resources: Option<i32>, /// Number of static (i.e. cacheable) resources on the page. #[serde(rename="numberStaticResources")] pub number_static_resources: Option<i32>, } impl NestedType for ResultPageStats {} impl Part for ResultPageStats {} /// The enum-like identifier for this rule. For instance "EnableKeepAlive" or "AvoidCssImport". Not localized. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultFormattedResultsRuleResults { /// Localized name of the rule, intended for presentation to a user. #[serde(rename="localizedRuleName")] pub localized_rule_name: Option<String>, /// List of blocks of URLs. Each block may contain a heading and a list of URLs. Each URL may optionally include additional details. #[serde(rename="urlBlocks")] pub url_blocks: Option<Vec<ResultFormattedResultsRuleResultsUrlBlocks>>, /// List of rule groups that this rule belongs to. Each entry in the list is one of "SPEED" or "USABILITY". pub groups: Option<Vec<String>>, /// The impact (unbounded floating point value) that implementing the suggestions for this rule would have on making the page faster. Impact is comparable between rules to determine which rule's suggestions would have a higher or lower impact on making a page faster. For instance, if enabling compression would save 1MB, while optimizing images would save 500kB, the enable compression rule would have 2x the impact of the image optimization rule, all other things being equal. #[serde(rename="ruleImpact")] pub rule_impact: Option<f64>, /// A brief summary description for the rule, indicating at a high level what should be done to follow the rule and what benefit can be gained by doing so. pub summary: Option<PagespeedApiFormatStringV2>, } impl NestedType for ResultFormattedResultsRuleResults {} impl Part for ResultFormattedResultsRuleResults {} /// The version of PageSpeed used to generate these results. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultVersion { /// The major version number of PageSpeed used to generate these results. pub major: Option<i32>, /// The minor version number of PageSpeed used to generate these results. pub minor: Option<i32>, } impl NestedType for ResultVersion {} impl Part for ResultVersion {} /// List of arguments for the format string. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct PagespeedApiFormatStringV2Args { /// The screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. If this is absent for a SNAPSHOT_RECT argument, it means that that argument refers to the entire snapshot. pub rects: Option<Vec<PagespeedApiFormatStringV2ArgsRects>>, /// The placeholder key for this arg, as a string. pub key: Option<String>, /// Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, DURATION, VERBATIM_STRING, PERCENTAGE, HYPERLINK, or SNAPSHOT_RECT. #[serde(rename="type")] pub type_: Option<String>, /// Secondary screen rectangles being referred to, with dimensions measured in CSS pixels. This is only ever used for SNAPSHOT_RECT arguments. pub secondary_rects: Option<Vec<PagespeedApiFormatStringV2ArgsSecondaryRects>>, /// Argument value, as a localized string. pub value: Option<String>, } impl NestedType for PagespeedApiFormatStringV2Args {} impl Part for PagespeedApiFormatStringV2Args {} /// List of blocks of URLs. Each block may contain a heading and a list of URLs. Each URL may optionally include additional details. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultFormattedResultsRuleResultsUrlBlocks { /// Heading to be displayed with the list of URLs. pub header: Option<PagespeedApiFormatStringV2>, /// List of entries that provide information about URLs in the url block. Optional. pub urls: Option<Vec<ResultFormattedResultsRuleResultsUrlBlocksUrls>>, } impl NestedType for ResultFormattedResultsRuleResultsUrlBlocks {} impl Part for ResultFormattedResultsRuleResultsUrlBlocks {} /// There is no detailed description. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct PagespeedApiImageV2 { /// Width of screenshot in pixels. pub width: Option<i32>, /// Unique string key, if any, identifying this image. pub key: Option<String>, /// The region of the page that is captured by this image, with dimensions measured in CSS pixels. pub page_rect: Option<PagespeedApiImageV2PageRect>, /// Image data base64 encoded. pub data: Option<String>, /// Mime type of image data (e.g. "image/jpeg"). pub mime_type: Option<String>, /// Height of screenshot in pixels. pub height: Option<i32>, } impl Part for PagespeedApiImageV2 {} /// There is no detailed description. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [runpagespeed pagespeedapi](struct.PagespeedapiRunpagespeedCall.html) (response) /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultType { /// Kind of result. pub kind: Option<String>, /// The captcha verify result #[serde(rename="captchaResult")] pub captcha_result: Option<String>, /// Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. #[serde(rename="formattedResults")] pub formatted_results: Option<ResultFormattedResults>, /// Base64-encoded screenshot of the page that was analyzed. pub screenshot: Option<PagespeedApiImageV2>, /// Title of the page, as displayed in the browser's title bar. pub title: Option<String>, /// A map with one entry for each rule group in these results. #[serde(rename="ruleGroups")] pub rule_groups: Option<HashMap<String, ResultRuleGroups>>, /// The version of PageSpeed used to generate these results. pub version: Option<ResultVersion>, /// Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error. #[serde(rename="responseCode")] pub response_code: Option<i32>, /// List of rules that were specified in the request, but which the server did not know how to instantiate. #[serde(rename="invalidRules")] pub invalid_rules: Option<Vec<String>>, /// Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc. #[serde(rename="pageStats")] pub page_stats: Option<ResultPageStats>, /// Canonicalized and final URL for the document, after following page redirects (if any). pub id: Option<String>, } impl ResponseResult for ResultType {} /// The region of the page that is captured by this image, with dimensions measured in CSS pixels. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct PagespeedApiImageV2PageRect { /// The width of the rect. pub width: Option<i32>, /// The top coordinate of the rect, in page coordinates. pub top: Option<i32>, /// The height of the rect. pub height: Option<i32>, /// The left coordinate of the rect, in page coordinates. pub left: Option<i32>, } impl NestedType for PagespeedApiImageV2PageRect {} impl Part for PagespeedApiImageV2PageRect {} /// Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server. /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultFormattedResults { /// The locale of the formattedResults, e.g. "en_US". pub locale: Option<String>, /// Dictionary of formatted rule results, with one entry for each PageSpeed rule instantiated and run by the server. #[serde(rename="ruleResults")] pub rule_results: Option<HashMap<String, ResultFormattedResultsRuleResults>>, } impl NestedType for ResultFormattedResults {} impl Part for ResultFormattedResults {} /// The name of this rule group: one of "SPEED" or "USABILITY". /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[derive(Default, Clone, Debug, Serialize, Deserialize)] pub struct ResultRuleGroups { /// The score (0-100) for this rule group, which indicates how much better a page could be in that category (e.g. how much faster, or how much more usable). A high score indicates little room for improvement, while a lower score indicates more room for improvement. pub score: Option<i32>, } impl NestedType for ResultRuleGroups {} impl Part for ResultRuleGroups {} // ################### // MethodBuilders ### // ################# /// A builder providing access to all methods supported on *pagespeedapi* resources. /// It is not used directly, but through the `Pagespeedonline` hub. /// /// # Example /// /// Instantiate a resource builder /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate yup_oauth2 as oauth2; /// extern crate google_pagespeedonline2 as pagespeedonline2; /// /// # #[test] fn egal() { /// use std::default::Default; /// use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// use pagespeedonline2::Pagespeedonline; /// /// let secret: ApplicationSecret = Default::default(); /// let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// <MemoryStorage as Default>::default(), None); /// let mut hub = Pagespeedonline::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders* /// // like `runpagespeed(...)` /// // to build up your call. /// let rb = hub.pagespeedapi(); /// # } /// ``` pub struct PagespeedapiMethods<'a, C, A> where C: 'a, A: 'a { hub: &'a Pagespeedonline<C, A>, } impl<'a, C, A> MethodsBuilder for PagespeedapiMethods<'a, C, A> {} impl<'a, C, A> PagespeedapiMethods<'a, C, A> { /// Create a builder to help you perform the following task: /// /// Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information. /// /// # Arguments /// /// * `url` - The URL to fetch and analyze pub fn runpagespeed(&self, url: &str) -> PagespeedapiRunpagespeedCall<'a, C, A> { PagespeedapiRunpagespeedCall { hub: self.hub, _url: url.to_string(), _strategy: Default::default(), _screenshot: Default::default(), _rule: Default::default(), _locale: Default::default(), _filter_third_party_resources: Default::default(), _delegate: Default::default(), _additional_params: Default::default(), } } } // ################### // CallBuilders ### // ################# /// Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information. /// /// A builder for the *runpagespeed* method supported by a *pagespeedapi* resource. /// It is not used directly, but through a `PagespeedapiMethods` instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate yup_oauth2 as oauth2; /// # extern crate google_pagespeedonline2 as pagespeedonline2; /// # #[test] fn egal() { /// # use std::default::Default; /// # use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; /// # use pagespeedonline2::Pagespeedonline; /// /// # let secret: ApplicationSecret = Default::default(); /// # let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, /// # hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), /// # <MemoryStorage as Default>::default(), None); /// # let mut hub = Pagespeedonline::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); /// // You can configure optional parameters by calling the respective setters at will, and /// // execute the final call using `doit()`. /// // Values shown here are possibly random and not representative ! /// let result = hub.pagespeedapi().runpagespeed("url") /// .strategy("ea") /// .screenshot(false) /// .add_rule("justo") /// .locale("justo") /// .filter_third_party_resources(true) /// .doit(); /// # } /// ``` pub struct PagespeedapiRunpagespeedCall<'a, C, A> where C: 'a, A: 'a { hub: &'a Pagespeedonline<C, A>, _url: String, _strategy: Option<String>, _screenshot: Option<bool>, _rule: Vec<String>, _locale: Option<String>, _filter_third_party_resources: Option<bool>, _delegate: Option<&'a mut Delegate>, _additional_params: HashMap<String, String>, } impl<'a, C, A> CallBuilder for PagespeedapiRunpagespeedCall<'a, C, A> {} impl<'a, C, A> PagespeedapiRunpagespeedCall<'a, C, A> where C: BorrowMut<hyper::Client>, A: oauth2::GetToken { /// Perform the operation you have build so far. pub fn doit(mut self) -> Result<(hyper::client::Response, ResultType)> { use std::io::{Read, Seek}; use hyper::header::{ContentType, ContentLength, Authorization, Bearer, UserAgent, Location}; let mut dd = DefaultDelegate; let mut dlg: &mut Delegate = match self._delegate { Some(d) => d, None => &mut dd }; dlg.begin(MethodInfo { id: "pagespeedonline.pagespeedapi.runpagespeed", http_method: hyper::method::Method::Get }); let mut params: Vec<(&str, String)> = Vec::with_capacity(8 + self._additional_params.len()); params.push(("url", self._url.to_string())); if let Some(value) = self._strategy { params.push(("strategy", value.to_string())); } if let Some(value) = self._screenshot { params.push(("screenshot", value.to_string())); } if self._rule.len() > 0 { for f in self._rule.iter() { params.push(("rule", f.to_string())); } } if let Some(value) = self._locale { params.push(("locale", value.to_string())); } if let Some(value) = self._filter_third_party_resources { params.push(("filter_third_party_resources", value.to_string())); } for &field in ["alt", "url", "strategy", "screenshot", "rule", "locale", "filter_third_party_resources"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(Error::FieldClash(field)); } } for (name, value) in self._additional_params.iter() { params.push((&name, value.clone())); } params.push(("alt", "json".to_string())); let mut url = self.hub._base_url.clone() + "runPagespeed"; let mut key = self.hub.auth.borrow_mut().api_key(); if key.is_none() { key = dlg.api_key(); } match key { Some(value) => params.push(("key", value)), None => { dlg.finished(false); return Err(Error::MissingAPIKey) } } let url = hyper::Url::parse_with_params(&url, params).unwrap(); loop { let mut req_result = { let mut client = &mut *self.hub.client.borrow_mut(); let mut req = client.borrow_mut().request(hyper::method::Method::Get, url.clone()) .header(UserAgent(self.hub._user_agent.clone())); dlg.pre_request(); req.send() }; match req_result { Err(err) => { if let oauth2::Retry::After(d) = dlg.http_error(&err) { sleep(d); continue; } dlg.finished(false); return Err(Error::HttpError(err)) } Ok(mut res) => { if !res.status.is_success() { let mut json_err = String::new(); res.read_to_string(&mut json_err).unwrap(); if let oauth2::Retry::After(d) = dlg.http_failure(&res, json::from_str(&json_err).ok(), json::from_str(&json_err).ok()) { sleep(d); continue; } dlg.finished(false); return match json::from_str::<ErrorResponse>(&json_err){ Err(_) => Err(Error::Failure(res)), Ok(serr) => Err(Error::BadRequest(serr)) } } let result_value = { let mut json_response = String::new(); res.read_to_string(&mut json_response).unwrap(); match json::from_str(&json_response) { Ok(decoded) => (res, decoded), Err(err) => { dlg.response_json_decode_error(&json_response, &err); return Err(Error::JsonDecodeError(json_response, err)); } } }; dlg.finished(true); return Ok(result_value) } } } } /// The URL to fetch and analyze /// /// Sets the *url* query property to the given value. /// /// Even though the property as already been set when instantiating this call, /// we provide this method for API completeness. pub fn url(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, C, A> { self._url = new_value.to_string(); self } /// The analysis strategy to use /// /// Sets the *strategy* query property to the given value. pub fn strategy(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, C, A> { self._strategy = Some(new_value.to_string()); self } /// Indicates if binary data containing a screenshot should be included /// /// Sets the *screenshot* query property to the given value. pub fn screenshot(mut self, new_value: bool) -> PagespeedapiRunpagespeedCall<'a, C, A> { self._screenshot = Some(new_value); self } /// A PageSpeed rule to run; if none are given, all rules are run /// /// Append the given value to the *rule* query property. /// Each appended value will retain its original ordering and be '/'-separated in the URL's parameters. pub fn add_rule(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, C, A> { self._rule.push(new_value.to_string()); self } /// The locale used to localize formatted results /// /// Sets the *locale* query property to the given value. pub fn locale(mut self, new_value: &str) -> PagespeedapiRunpagespeedCall<'a, C, A> { self._locale = Some(new_value.to_string()); self } /// Indicates if third party resources should be filtered out before PageSpeed analysis. /// /// Sets the *filter_third_party_resources* query property to the given value. pub fn filter_third_party_resources(mut self, new_value: bool) -> PagespeedapiRunpagespeedCall<'a, C, A> { self._filter_third_party_resources = Some(new_value); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// It should be used to handle progress information, and to implement a certain level of resilience. /// /// Sets the *delegate* property to the given value. pub fn delegate(mut self, new_value: &'a mut Delegate) -> PagespeedapiRunpagespeedCall<'a, C, A> { self._delegate = Some(new_value); self } /// Set any additional parameter of the query string used in the request. /// It should be used to set parameters which are not yet available through their own /// setters. /// /// Please note that this method must not be used to set any of the known parameters /// which have their own setter method. If done anyway, the request will fail. /// /// # Additional Parameters /// /// * *quotaUser* (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. /// * *oauth_token* (query-string) - OAuth 2.0 token for the current user. /// * *key* (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. /// * *prettyPrint* (query-boolean) - Returns response with indentations and line breaks. /// * *userIp* (query-string) - Deprecated. Please use quotaUser instead. /// * *fields* (query-string) - Selector specifying which fields to include in a partial response. /// * *alt* (query-string) - Data format for the response. pub fn param<T>(mut self, name: T, value: T) -> PagespeedapiRunpagespeedCall<'a, C, A> where T: AsRef<str> { self._additional_params.insert(name.as_ref().to_string(), value.as_ref().to_string()); self } }