diff --git a/.github/codecov.yml b/.github/codecov.yml new file mode 100644 index 0000000000..959972a69c --- /dev/null +++ b/.github/codecov.yml @@ -0,0 +1 @@ +comment: false \ No newline at end of file diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml new file mode 100644 index 0000000000..7ec3baf38a --- /dev/null +++ b/.github/workflows/codecov.yml @@ -0,0 +1,52 @@ +# This doesn't work currently there is a bug in the output of grcov +on: + push: + branches: + - master + - trying + +name: Code Coverage +jobs: + coverage: + name: Run test coverage + runs-on: ubuntu-latest + continue-on-error: true + steps: + - uses: actions/checkout@v1 + with: + submodules: recursive + - name: Toolchain setup + uses: actions-rs/toolchain@v1 + with: + toolchain: nightly + override: true + components: llvm-tools-preview + - name: Cache cargo + uses: actions/cache@v2 + id: cache + with: + path: | + ~/.cargo/registry + ~/.cargo/git + ~/.cargo/bin + key: ${{ runner.os }}-nightly-cargo-target-cov-${{ hashFiles('**/Cargo.lock') }} + restore-keys: ${{ runner.os }}-nightly-cargo-target-${{ hashFiles('**/Cargo.lock') }} + - name: Install cargo-llvm-cov + run: curl -LsSf https://github.com/taiki-e/cargo-llvm-cov/releases/latest/download/cargo-llvm-cov-x86_64-unknown-linux-gnu.tar.gz | tar xzf - -C ~/.cargo/bin + - name: Generate code coverage + # env: + # RUSTFLAGS: '-Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests' + # RUSTDOCFLAGS: '-Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests' + run: cargo llvm-cov --features "twitch_oauth2/all all unsupported deny_unknown_fields trace_unknown_fields" --doctests --ignore-filename-regex "twitch_oauth2" --lcov --output-path lcov.info + - name: Determine PR number + if: ${{ github.ref == 'refs/heads/trying' }} + run: git log -1 --pretty=format:"%s" | awk '{ print "PR_NUMBER=" substr($NF,2,length($NF)-2) }' >> $GITHUB_ENV + # - name: Determine actual commit + # if: ${{ github.ref == 'refs/heads/trying' }} + # run: git rev-parse HEAD~1 | awk '{ print "ACTUAL_COMMIT_SHA=" $NF }' >> $GITHUB_ENV + - name: Upload to codecov.io + uses: codecov/codecov-action@v2 + with: + files: ./lcov.info + override_pr: ${{env.PR_NUMBER}} + # override_commit: ${{env.ACTUAL_COMMIT_SHA}} diff --git a/.github/workflows/codecov.yml.x b/.github/workflows/codecov.yml.x deleted file mode 100644 index a63330e8a6..0000000000 --- a/.github/workflows/codecov.yml.x +++ /dev/null @@ -1,51 +0,0 @@ -# This doesn't work currently there is a bug in the output of grcov -on: - push: - branches: - - master - - staging - - trying - -name: Code Coverage -jobs: - coverage: - name: Run test coverage - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - with: - submodules: recursive - - name: Toolchain setup - uses: actions-rs/toolchain@v1 - with: - toolchain: nightly - override: true - components: llvm-tools-preview - - name: Cache cargo - uses: actions/cache@v2 - id: cache - with: - path: | - ~/.cargo/registry - ~/.cargo/git - target - key: ${{ runner.os }}-nightly-cargo-target-cov-${{ hashFiles('**/Cargo.lock') }} - restore-keys: ${{ runner.os }}-nightly-cargo-target-${{ hashFiles('**/Cargo.lock') }} - - uses: actions-rs/cargo@v1 - continue-on-error: true - with: - command: test - args: --no-fail-fast --features "twitch_oauth2/all all unsupported deny_unknown_fields trace_unknown_fields" - env: - CARGO_INCREMENTAL: '0' - RUSTFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests' - RUSTDOCFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests' - - id: coverage - uses: actions-rs/grcov@v0.1 - continue-on-error: true - - name: Coveralls upload - uses: coverallsapp/github-action@master - continue-on-error: true - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - path-to-lcov: ${{ steps.coverage.outputs.report }} \ No newline at end of file diff --git a/src/eventsub/mod.rs b/src/eventsub/mod.rs index e300b6f015..875bf9f7f2 100644 --- a/src/eventsub/mod.rs +++ b/src/eventsub/mod.rs @@ -9,7 +9,7 @@ //! //! To parse these, use [`Payload::parse`] //! -//! ```rust,no_run +//! ```rust //! use twitch_api2::eventsub::Payload; //! let payload = r#"{ //! "subscription": { diff --git a/src/helix/bits/get_cheermotes.rs b/src/helix/bits/get_cheermotes.rs index fd3a1f74c7..4b4548f1e6 100644 --- a/src/helix/bits/get_cheermotes.rs +++ b/src/helix/bits/get_cheermotes.rs @@ -8,7 +8,7 @@ //! To use this endpoint, construct a [`GetCheermotesRequest`] with the [`GetCheermotesRequest::builder()`] method. //! If you do not provide an ID, the request will only include global cheermotes as defined by twitch. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::bits::get_cheermotes; //! let request = get_cheermotes::GetCheermotesRequest::builder() //! .broadcaster_id(Some("1234".into())) diff --git a/src/helix/channels/get_channel_editors.rs b/src/helix/channels/get_channel_editors.rs index 4a13bf2930..d6069bba41 100644 --- a/src/helix/channels/get_channel_editors.rs +++ b/src/helix/channels/get_channel_editors.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetChannelEditorsRequest`] with the [`GetChannelEditorsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::channels::get_channel_editors; //! let request = get_channel_editors::GetChannelEditorsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/channels/get_channel_information.rs b/src/helix/channels/get_channel_information.rs index 638dc5b35b..0898b5641f 100644 --- a/src/helix/channels/get_channel_information.rs +++ b/src/helix/channels/get_channel_information.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetChannelInformationRequest`] with the [`GetChannelInformationRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::channels::get_channel_information; //! let request = get_channel_information::GetChannelInformationRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/channels/modify_channel_information.rs b/src/helix/channels/modify_channel_information.rs index 691bd77a0d..365e685711 100644 --- a/src/helix/channels/modify_channel_information.rs +++ b/src/helix/channels/modify_channel_information.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`ModifyChannelInformationRequest`] with the [`ModifyChannelInformationRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::channels::modify_channel_information; //! let request = modify_channel_information::ModifyChannelInformationRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/channels/start_commercial.rs b/src/helix/channels/start_commercial.rs index a53ff91e3c..060ab8bcf0 100644 --- a/src/helix/channels/start_commercial.rs +++ b/src/helix/channels/start_commercial.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`StartCommercialRequest`] with the [`StartCommercialRequest::new()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::channels::start_commercial; //! let request = start_commercial::StartCommercialRequest::new(); //! ``` diff --git a/src/helix/chat/get_channel_chat_badges.rs b/src/helix/chat/get_channel_chat_badges.rs index 40319a2c1b..85ca2b8c3b 100644 --- a/src/helix/chat/get_channel_chat_badges.rs +++ b/src/helix/chat/get_channel_chat_badges.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetChannelChatBadgesRequest`] with the [`GetChannelChatBadgesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::chat::get_channel_chat_badges; //! let request = get_channel_chat_badges::GetChannelChatBadgesRequest::builder() //! .broadcaster_id("1234".to_string()) diff --git a/src/helix/chat/get_channel_emotes.rs b/src/helix/chat/get_channel_emotes.rs index a0865b7543..5e987a9b80 100644 --- a/src/helix/chat/get_channel_emotes.rs +++ b/src/helix/chat/get_channel_emotes.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetChannelEmotesRequest`] with the [`GetChannelEmotesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::chat::get_channel_emotes; //! let request = get_channel_emotes::GetChannelEmotesRequest::builder() //! .broadcaster_id("1234".to_string()) diff --git a/src/helix/chat/get_emote_sets.rs b/src/helix/chat/get_emote_sets.rs index 0a0f25160f..d5e0659a08 100644 --- a/src/helix/chat/get_emote_sets.rs +++ b/src/helix/chat/get_emote_sets.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetEmoteSetsRequest`] with the [`GetEmoteSetsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::chat::get_emote_sets; //! let request = get_emote_sets::GetEmoteSetsRequest::builder() //! .emote_set_id(vec!["1234".into()]) diff --git a/src/helix/chat/get_global_chat_badges.rs b/src/helix/chat/get_global_chat_badges.rs index 85b310e3d5..2afc1e7494 100644 --- a/src/helix/chat/get_global_chat_badges.rs +++ b/src/helix/chat/get_global_chat_badges.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetGlobalChatBadgesRequest`] with the [`GetGlobalChatBadgesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::chat::get_global_chat_badges; //! let request = get_global_chat_badges::GetGlobalChatBadgesRequest::new(); //! ``` diff --git a/src/helix/chat/get_global_emotes.rs b/src/helix/chat/get_global_emotes.rs index f00b8d8c01..86d36d3d34 100644 --- a/src/helix/chat/get_global_emotes.rs +++ b/src/helix/chat/get_global_emotes.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetGlobalEmotesRequest`] with the [`GetGlobalEmotesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::chat::get_global_emotes; //! let request = get_global_emotes::GetGlobalEmotesRequest::default(); //! ``` diff --git a/src/helix/clips/get_clips.rs b/src/helix/clips/get_clips.rs index 5efe320909..7b019e67b5 100644 --- a/src/helix/clips/get_clips.rs +++ b/src/helix/clips/get_clips.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetClipsRequest`] with the [`GetClipsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::clips::get_clips; //! let request = get_clips::GetClipsRequest::builder() //! .broadcaster_id(Some("1234".into())) diff --git a/src/helix/games/get_games.rs b/src/helix/games/get_games.rs index 24546701d5..96c55ccc89 100644 --- a/src/helix/games/get_games.rs +++ b/src/helix/games/get_games.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetGamesRequest`] with the [`GetGamesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::games::get_games; //! let request = get_games::GetGamesRequest::builder() //! .id(vec!["4321".into()]) diff --git a/src/helix/games/get_top_games.rs b/src/helix/games/get_top_games.rs index 8da0617b09..a7b7ff652b 100644 --- a/src/helix/games/get_top_games.rs +++ b/src/helix/games/get_top_games.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetTopGamesRequest`] with the [`GetTopGamesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::games::get_top_games; //! let request = get_top_games::GetTopGamesRequest::builder() //! .first(100) diff --git a/src/helix/hypetrain/get_hypetrain_events.rs b/src/helix/hypetrain/get_hypetrain_events.rs index 8fca56d55d..a38c8b66cd 100644 --- a/src/helix/hypetrain/get_hypetrain_events.rs +++ b/src/helix/hypetrain/get_hypetrain_events.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetHypeTrainEventsRequest`] with the [`GetHypeTrainEventsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::hypetrain::get_hypetrain_events; //! let request = get_hypetrain_events::GetHypeTrainEventsRequest::builder() //! .broadcaster_id("4321".to_string()) diff --git a/src/helix/mod.rs b/src/helix/mod.rs index 8868a4cdb7..b604a596f2 100644 --- a/src/helix/mod.rs +++ b/src/helix/mod.rs @@ -4,7 +4,7 @@ //! Aside from using [`HelixClient`] as described on [the crate documentation](crate), //! you can decide to use this library without any specific client implementation. //! -//! ```rust,no_run +//! ```rust //! use twitch_api2::helix::{self, Request, RequestGet, users::{GetUsersRequest, User}}; //! //! # #[tokio::main] @@ -24,8 +24,16 @@ //! println!("{:#?}", user); //! # Ok(()) //! # } -//! # fn send_http_request(_: http::Request>) -> Result>,&'static str> {todo!()} +//! # fn send_http_request(_: http::Request>) -> Result>,&'static str> { +//! # Ok(http::Response::builder().body(r#"{"data":[{"id":"141981764","login":"twitchdev","display_name":"TwitchDev","type":"","broadcaster_type":"partner","description":"Supportingthird-partydevelopersbuildingTwitchintegrationsfromchatbotstogameintegrations.","profile_image_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/8a6381c7-d0c0-4576-b179-38bd5ce1d6af-profile_image-300x300.png","offline_image_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/3f13ab61-ec78-4fe6-8481-8682cb3b0ac2-channel_offline_image-1920x1080.png","view_count":5980557,"email":"not-real@email.com","created_at":"2016-12-14T20:32:28.894263Z"}]}"#.as_bytes().to_owned()).unwrap()) +//! # } //! ``` +//! + +// fn send_http_request(_: http::Request>) -> Result>, &'static str> { +// Ok(http::Response::builder().body(r#"{"data":[{"id":"141981764","login":"twitchdev","display_name":"TwitchDev","type":"","broadcaster_type":"partner","description":"Supportingthird-partydevelopersbuildingTwitchintegrationsfromchatbotstogameintegrations.","profile_image_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/8a6381c7-d0c0-4576-b179-38bd5ce1d6af-profile_image-300x300.png","offline_image_url":"https://static-cdn.jtvnw.net/jtv_user_pictures/3f13ab61-ec78-4fe6-8481-8682cb3b0ac2-channel_offline_image-1920x1080.png","view_count":5980557,"email":"not-real@email.com","created_at":"2016-12-14T20:32:28.894263Z"}]}"#.as_bytes().to_owned()).unwrap()) +// } + use serde::Deserialize; use std::{convert::TryInto, str::FromStr}; #[cfg(feature = "twitch_oauth2")] diff --git a/src/helix/moderation/check_automod_status.rs b/src/helix/moderation/check_automod_status.rs index e86b2a76e8..0b53a2c9d0 100644 --- a/src/helix/moderation/check_automod_status.rs +++ b/src/helix/moderation/check_automod_status.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`CheckAutoModStatusRequest`] with the [`CheckAutoModStatusRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::moderation::check_automod_status; //! let request = check_automod_status::CheckAutoModStatusRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/moderation/get_banned_events.rs b/src/helix/moderation/get_banned_events.rs index 6e858210ff..a2ba1d737f 100644 --- a/src/helix/moderation/get_banned_events.rs +++ b/src/helix/moderation/get_banned_events.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetBannedEventsRequest`] with the [`GetBannedEventsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::moderation::get_banned_events; //! let request = get_banned_events::GetBannedEventsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/moderation/get_banned_users.rs b/src/helix/moderation/get_banned_users.rs index 044f7b8584..c3e589409e 100644 --- a/src/helix/moderation/get_banned_users.rs +++ b/src/helix/moderation/get_banned_users.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetBannedUsersRequest`] with the [`GetBannedUsersRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::moderation::get_banned_users; //! let request = get_banned_users::GetBannedUsersRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/moderation/get_moderator_events.rs b/src/helix/moderation/get_moderator_events.rs index ab11a160c2..fa3d47cced 100644 --- a/src/helix/moderation/get_moderator_events.rs +++ b/src/helix/moderation/get_moderator_events.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetModeratorEventsRequest`] with the [`GetModeratorEventsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::moderation::get_moderator_events; //! let request = get_moderator_events::GetModeratorEventsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/moderation/get_moderators.rs b/src/helix/moderation/get_moderators.rs index 67a8c8e422..f87ee0c8bc 100644 --- a/src/helix/moderation/get_moderators.rs +++ b/src/helix/moderation/get_moderators.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetModeratorsRequest`] with the [`GetModeratorsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::moderation::get_moderators; //! let request = get_moderators::GetModeratorsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/moderation/manage_held_automod_messages.rs b/src/helix/moderation/manage_held_automod_messages.rs index c7c62793a5..4fadaf98dd 100644 --- a/src/helix/moderation/manage_held_automod_messages.rs +++ b/src/helix/moderation/manage_held_automod_messages.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`ManageHeldAutoModMessagesRequest`] with the [`ManageHeldAutoModMessagesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::moderation::manage_held_automod_messages; //! let request = manage_held_automod_messages::ManageHeldAutoModMessagesRequest::new(); //! ``` @@ -132,7 +132,7 @@ impl Request for ManageHeldAutoModMessagesRequest { impl RequestPost for ManageHeldAutoModMessagesRequest { type Body = ManageHeldAutoModMessagesBody; - fn parse_inner_response( + fn parse_inner_response<'d>( request: Option, uri: &http::Uri, response: &str, diff --git a/src/helix/points/create_custom_rewards.rs b/src/helix/points/create_custom_rewards.rs index 855a5335ed..3f742d6289 100644 --- a/src/helix/points/create_custom_rewards.rs +++ b/src/helix/points/create_custom_rewards.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`CreateCustomRewardRequest`] with the [`CreateCustomRewardRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::points::create_custom_rewards; //! let request = create_custom_rewards::CreateCustomRewardRequest::builder() //! .broadcaster_id("274637212") diff --git a/src/helix/points/delete_custom_reward.rs b/src/helix/points/delete_custom_reward.rs index ee186969d9..671ce32a63 100644 --- a/src/helix/points/delete_custom_reward.rs +++ b/src/helix/points/delete_custom_reward.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`DeleteCustomRewardRequest`] with the [`DeleteCustomRewardRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::points::delete_custom_reward; //! let request = delete_custom_reward::DeleteCustomRewardRequest::builder() //! .broadcaster_id("274637212") diff --git a/src/helix/points/get_custom_reward.rs b/src/helix/points/get_custom_reward.rs index 328e3c3ad3..cc24d10830 100644 --- a/src/helix/points/get_custom_reward.rs +++ b/src/helix/points/get_custom_reward.rs @@ -9,7 +9,7 @@ //! //! To use this endpoint, construct a [`GetCustomRewardRequest`] with the [`GetCustomRewardRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::points::GetCustomRewardRequest; //! let request = GetCustomRewardRequest::builder() //! .broadcaster_id("274637212".to_string()) diff --git a/src/helix/points/get_custom_reward_redemption.rs b/src/helix/points/get_custom_reward_redemption.rs index bcc1b05233..ff8be4d7aa 100644 --- a/src/helix/points/get_custom_reward_redemption.rs +++ b/src/helix/points/get_custom_reward_redemption.rs @@ -9,7 +9,7 @@ //! //! To use this endpoint, construct a [`GetCustomRewardRedemptionRequest`] with the [`GetCustomRewardRedemptionRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::points::{CustomRewardRedemptionStatus, GetCustomRewardRedemptionRequest}; //! let request = GetCustomRewardRedemptionRequest::builder() //! .broadcaster_id("274637212".to_string()) diff --git a/src/helix/points/update_custom_reward.rs b/src/helix/points/update_custom_reward.rs index 0c046c96c6..2968d7c2e7 100644 --- a/src/helix/points/update_custom_reward.rs +++ b/src/helix/points/update_custom_reward.rs @@ -9,7 +9,7 @@ //! //! To use this endpoint, construct an [`UpdateCustomRewardRequest`] with the [`UpdateCustomRewardRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::points::update_custom_reward; //! let request = update_custom_reward::UpdateCustomRewardRequest::builder() //! .broadcaster_id("274637212") diff --git a/src/helix/points/update_redemption_status.rs b/src/helix/points/update_redemption_status.rs index 15efe74d01..67ce70c92a 100644 --- a/src/helix/points/update_redemption_status.rs +++ b/src/helix/points/update_redemption_status.rs @@ -9,7 +9,7 @@ //! //! To use this endpoint, construct a [`UpdateRedemptionStatusRequest`] with the [`UpdateRedemptionStatusRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::points::UpdateRedemptionStatusRequest; //! let request = UpdateRedemptionStatusRequest::builder() //! .broadcaster_id("274637212".to_string()) diff --git a/src/helix/polls/create_poll.rs b/src/helix/polls/create_poll.rs index 82a3f69b29..10e3c6df6b 100644 --- a/src/helix/polls/create_poll.rs +++ b/src/helix/polls/create_poll.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`CreatePollRequest`] with the [`CreatePollRequest::new()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::polls::create_poll; //! let request = create_poll::CreatePollRequest::new(); //! ``` diff --git a/src/helix/polls/end_poll.rs b/src/helix/polls/end_poll.rs index 60d6678df5..90d2de7738 100644 --- a/src/helix/polls/end_poll.rs +++ b/src/helix/polls/end_poll.rs @@ -8,7 +8,7 @@ //! //! To use this endpoint, construct an [`EndPollRequest`] with the [`EndPollRequest::new()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::polls::end_poll; //! let request = end_poll::EndPollRequest::new(); //! ``` diff --git a/src/helix/polls/get_polls.rs b/src/helix/polls/get_polls.rs index ad6677f8a6..954a8946d0 100644 --- a/src/helix/polls/get_polls.rs +++ b/src/helix/polls/get_polls.rs @@ -5,7 +5,7 @@ //! //! To use this endpoint, construct a [`GetPollsRequest`] with the [`GetPollsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::polls::get_polls; //! let request = get_polls::GetPollsRequest::builder() //! .id(vec!["ed961efd-8a3f-4cf5-a9d0-e616c590cd2a".into()]) diff --git a/src/helix/predictions/create_prediction.rs b/src/helix/predictions/create_prediction.rs index 47254d1414..9d8c0ef9cb 100644 --- a/src/helix/predictions/create_prediction.rs +++ b/src/helix/predictions/create_prediction.rs @@ -9,7 +9,7 @@ //! //! To use this endpoint, construct a [`CreatePredictionRequest`] with the [`CreatePredictionRequest::new()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::predictions::create_prediction; //! let request = create_prediction::CreatePredictionRequest::new(); //! ``` diff --git a/src/helix/predictions/end_prediction.rs b/src/helix/predictions/end_prediction.rs index 1305b3c366..fc017242a3 100644 --- a/src/helix/predictions/end_prediction.rs +++ b/src/helix/predictions/end_prediction.rs @@ -8,7 +8,7 @@ //! //! To use this endpoint, construct an [`EndPredictionRequest`] with the [`EndPredictionRequest::new()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::predictions::end_prediction; //! let request = end_prediction::EndPredictionRequest::new(); //! ``` diff --git a/src/helix/predictions/get_predictions.rs b/src/helix/predictions/get_predictions.rs index 70a0ef97ae..47693997ae 100644 --- a/src/helix/predictions/get_predictions.rs +++ b/src/helix/predictions/get_predictions.rs @@ -5,7 +5,7 @@ //! //! To use this endpoint, construct a [`GetPredictionsRequest`] with the [`GetPredictionsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::predictions::get_predictions; //! let request = get_predictions::GetPredictionsRequest::builder() //! .id(vec!["ed961efd-8a3f-4cf5-a9d0-e616c590cd2a".into()]) diff --git a/src/helix/schedule/create_channel_stream_schedule_segment.rs b/src/helix/schedule/create_channel_stream_schedule_segment.rs index ebb96f124d..482afe715c 100644 --- a/src/helix/schedule/create_channel_stream_schedule_segment.rs +++ b/src/helix/schedule/create_channel_stream_schedule_segment.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`CreateChannelStreamScheduleSegmentRequest`] with the [`CreateChannelStreamScheduleSegmentRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::schedule::create_channel_stream_schedule_segment; //! let request = create_channel_stream_schedule_segment::CreateChannelStreamScheduleSegmentRequest::builder() //! .broadcaster_id("141981764") diff --git a/src/helix/schedule/delete_channel_stream_schedule_segment.rs b/src/helix/schedule/delete_channel_stream_schedule_segment.rs index e256318dc6..b8e18cf592 100644 --- a/src/helix/schedule/delete_channel_stream_schedule_segment.rs +++ b/src/helix/schedule/delete_channel_stream_schedule_segment.rs @@ -11,7 +11,7 @@ //! //! To use this endpoint, construct a [`DeleteChannelStreamScheduleSegmentRequest`] with the [`DeleteChannelStreamScheduleSegmentRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::schedule::delete_channel_stream_schedule_segment; //! let request = delete_channel_stream_schedule_segment::DeleteChannelStreamScheduleSegmentRequest::builder() //! .from_id("1234").to_id("4321") diff --git a/src/helix/schedule/get_channel_stream_schedule.rs b/src/helix/schedule/get_channel_stream_schedule.rs index 41975d2e7d..a7c9cb7f48 100644 --- a/src/helix/schedule/get_channel_stream_schedule.rs +++ b/src/helix/schedule/get_channel_stream_schedule.rs @@ -8,7 +8,7 @@ //! //! To use this endpoint, construct a [`GetChannelStreamScheduleRequest`] with the [`GetChannelStreamScheduleRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::schedule::get_channel_stream_schedule; //! let request = get_channel_stream_schedule::GetChannelStreamScheduleRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/schedule/update_channel_stream_schedule.rs b/src/helix/schedule/update_channel_stream_schedule.rs index b8340191a7..3dd076b3f9 100644 --- a/src/helix/schedule/update_channel_stream_schedule.rs +++ b/src/helix/schedule/update_channel_stream_schedule.rs @@ -8,7 +8,7 @@ //! //! To use this endpoint, construct an [`UpdateChannelStreamScheduleRequest`] with the [`UpdateChannelStreamScheduleRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::schedule::update_channel_stream_schedule; //! let request = update_channel_stream_schedule::UpdateChannelStreamScheduleRequest::builder() //! .broadcaster_id("274637212") diff --git a/src/helix/schedule/update_channel_stream_schedule_segment.rs b/src/helix/schedule/update_channel_stream_schedule_segment.rs index 0aa59da979..663787c869 100644 --- a/src/helix/schedule/update_channel_stream_schedule_segment.rs +++ b/src/helix/schedule/update_channel_stream_schedule_segment.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`UpdateChannelStreamScheduleSegmentRequest`] with the [`UpdateChannelStreamScheduleSegmentRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::schedule::update_channel_stream_schedule_segment; //! let request = update_channel_stream_schedule_segment::UpdateChannelStreamScheduleSegmentRequest::builder() //! .broadcaster_id("141981764") diff --git a/src/helix/search/search_categories.rs b/src/helix/search/search_categories.rs index 4aecb65779..07efc82411 100644 --- a/src/helix/search/search_categories.rs +++ b/src/helix/search/search_categories.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`SearchCategoriesRequest`] with the [`SearchCategoriesRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::search::search_categories; //! let request = search_categories::SearchCategoriesRequest::builder() //! .query("hello") diff --git a/src/helix/search/search_channels.rs b/src/helix/search/search_channels.rs index ed03ff38bf..af657c0dee 100644 --- a/src/helix/search/search_channels.rs +++ b/src/helix/search/search_channels.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`SearchChannelsRequest`] with the [`SearchChannelsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::search::search_channels; //! let request = search_channels::SearchChannelsRequest::builder() //! .query("hello") diff --git a/src/helix/streams/get_followed_streams.rs b/src/helix/streams/get_followed_streams.rs index 694629a413..9de8ddb212 100644 --- a/src/helix/streams/get_followed_streams.rs +++ b/src/helix/streams/get_followed_streams.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetFollowedStreamsRequest`] with the [`GetFollowedStreamsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::streams::get_followed_streams; //! let request = get_followed_streams::GetFollowedStreamsRequest::builder() //! .user_id("1234") diff --git a/src/helix/streams/get_stream_tags.rs b/src/helix/streams/get_stream_tags.rs index a5ac2a9bbc..376b9d73f7 100644 --- a/src/helix/streams/get_stream_tags.rs +++ b/src/helix/streams/get_stream_tags.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetStreamTagsRequest`] with the [`GetStreamTagsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::streams::get_stream_tags; //! let request = get_stream_tags::GetStreamTagsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/streams/get_streams.rs b/src/helix/streams/get_streams.rs index 684eff5e3e..6d24429da7 100644 --- a/src/helix/streams/get_streams.rs +++ b/src/helix/streams/get_streams.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetStreamsRequest`] with the [`GetStreamsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::streams::get_streams; //! let request = get_streams::GetStreamsRequest::builder() //! .user_login(vec!["justintvfan".into()]) diff --git a/src/helix/streams/replace_stream_tags.rs b/src/helix/streams/replace_stream_tags.rs index c50f15fcfb..33b7eab18d 100644 --- a/src/helix/streams/replace_stream_tags.rs +++ b/src/helix/streams/replace_stream_tags.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`ReplaceStreamTagsRequest`] with the [`ReplaceStreamTagsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::streams::replace_stream_tags; //! let request = replace_stream_tags::ReplaceStreamTagsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/subscriptions/check_user_subscription.rs b/src/helix/subscriptions/check_user_subscription.rs index cc301c2312..540e74b0da 100644 --- a/src/helix/subscriptions/check_user_subscription.rs +++ b/src/helix/subscriptions/check_user_subscription.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`CheckUserSubscriptionRequest`] with the [`CheckUserSubscriptionRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::subscriptions::check_user_subscription; //! let request = check_user_subscription::CheckUserSubscriptionRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/subscriptions/get_broadcaster_subscriptions.rs b/src/helix/subscriptions/get_broadcaster_subscriptions.rs index eb8a750061..49d319de0f 100644 --- a/src/helix/subscriptions/get_broadcaster_subscriptions.rs +++ b/src/helix/subscriptions/get_broadcaster_subscriptions.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetBroadcasterSubscriptionsRequest`] with the [`GetBroadcasterSubscriptionsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::subscriptions::get_broadcaster_subscriptions; //! let request = get_broadcaster_subscriptions::GetBroadcasterSubscriptionsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/subscriptions/get_broadcaster_subscriptions_events.rs b/src/helix/subscriptions/get_broadcaster_subscriptions_events.rs index 092bb8a1d1..5dbfe4c631 100644 --- a/src/helix/subscriptions/get_broadcaster_subscriptions_events.rs +++ b/src/helix/subscriptions/get_broadcaster_subscriptions_events.rs @@ -12,7 +12,7 @@ //! //! To use this endpoint, construct a [`GetBroadcasterSubscriptionsEventsRequest`] with the [`GetBroadcasterSubscriptionsEventsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::subscriptions::get_broadcaster_subscriptions_events; //! let request = get_broadcaster_subscriptions_events::GetBroadcasterSubscriptionsEventsRequest::builder() //! .broadcaster_id("1234") diff --git a/src/helix/tags/get_all_stream_tags.rs b/src/helix/tags/get_all_stream_tags.rs index d517c8ab97..2b49a32973 100644 --- a/src/helix/tags/get_all_stream_tags.rs +++ b/src/helix/tags/get_all_stream_tags.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetAllStreamTagsRequest`] with the [`GetAllStreamTagsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::tags::get_all_stream_tags; //! let request = get_all_stream_tags::GetAllStreamTagsRequest::builder() //! .first(100) diff --git a/src/helix/teams/get_channel_teams.rs b/src/helix/teams/get_channel_teams.rs index f6b8da7dc8..c857316bd6 100644 --- a/src/helix/teams/get_channel_teams.rs +++ b/src/helix/teams/get_channel_teams.rs @@ -5,7 +5,7 @@ //! //! To use this endpoint, construct a [`GetChannelTeamsRequest`] with the [`GetChannelTeamsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::teams::get_channel_teams; //! let request = get_channel_teams::GetChannelTeamsRequest::builder() //! .broadcaster_id("1337") diff --git a/src/helix/teams/get_teams.rs b/src/helix/teams/get_teams.rs index 6d70b01eb0..294143e47f 100644 --- a/src/helix/teams/get_teams.rs +++ b/src/helix/teams/get_teams.rs @@ -5,7 +5,7 @@ //! //! To use this endpoint, construct a [`GetTeamsRequest`] with the [`GetTeamsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::teams::get_teams; //! let request = get_teams::GetTeamsRequest::builder() //! .name("coolteam".to_string()) diff --git a/src/helix/users/block_user.rs b/src/helix/users/block_user.rs index 959c4750ba..7a146223ee 100644 --- a/src/helix/users/block_user.rs +++ b/src/helix/users/block_user.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`BlockUserRequest`] with the [`BlockUserRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::users::block_user::{self, SourceContext, Reason}; //! let request = block_user::BlockUserRequest::builder() //! .target_user_id("1234") diff --git a/src/helix/users/get_user_block_list.rs b/src/helix/users/get_user_block_list.rs index eab5359354..f7ac1c2406 100644 --- a/src/helix/users/get_user_block_list.rs +++ b/src/helix/users/get_user_block_list.rs @@ -5,7 +5,7 @@ //! //! To use this endpoint, construct a [`GetUserBlockListRequest`] with the [`GetUserBlockListRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::users::get_user_block_list; //! let request = get_user_block_list::GetUserBlockListRequest::builder() //! .broadcaster_id("1234".to_string()) diff --git a/src/helix/users/get_users.rs b/src/helix/users/get_users.rs index e4019fc943..e09c474595 100644 --- a/src/helix/users/get_users.rs +++ b/src/helix/users/get_users.rs @@ -5,7 +5,7 @@ //! //! To use this endpoint, construct a [`GetUsersRequest`] with the [`GetUsersRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::users::get_users; //! let request = get_users::GetUsersRequest::builder() //! .id(vec!["1234".into()]) diff --git a/src/helix/users/get_users_follows.rs b/src/helix/users/get_users_follows.rs index d74687817c..ae212ad955 100644 --- a/src/helix/users/get_users_follows.rs +++ b/src/helix/users/get_users_follows.rs @@ -5,7 +5,7 @@ //! //! To use this endpoint, construct a [`GetUsersFollowsRequest`] with the [`GetUsersFollowsRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::users::get_users_follows; //! let request = get_users_follows::GetUsersFollowsRequest::builder() //! .to_id(Some("1234".into())) diff --git a/src/helix/users/unblock_user.rs b/src/helix/users/unblock_user.rs index 3e173194d1..047c47c18b 100644 --- a/src/helix/users/unblock_user.rs +++ b/src/helix/users/unblock_user.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`UnblockUserRequest`] with the [`UnblockUserRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::users::unblock_user; //! let request = unblock_user::UnblockUserRequest::builder() //! .target_user_id("1234") diff --git a/src/helix/videos/delete_videos.rs b/src/helix/videos/delete_videos.rs index 0c0719779c..39ec755e91 100644 --- a/src/helix/videos/delete_videos.rs +++ b/src/helix/videos/delete_videos.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`DeleteVideosRequest`] with the [`DeleteVideosRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::videos::delete_videos; //! let request = delete_videos::DeleteVideosRequest::builder() //! .id(vec!["1234".into()]) diff --git a/src/helix/videos/get_videos.rs b/src/helix/videos/get_videos.rs index 2d91736824..098c82c921 100644 --- a/src/helix/videos/get_videos.rs +++ b/src/helix/videos/get_videos.rs @@ -7,7 +7,7 @@ //! //! To use this endpoint, construct a [`GetVideosRequest`] with the [`GetVideosRequest::builder()`] method. //! -//! ```rust, no_run +//! ```rust //! use twitch_api2::helix::videos::get_videos; //! let request = get_videos::GetVideosRequest::builder() //! .user_id(Some("1234".into())) diff --git a/src/tmi/mod.rs b/src/tmi/mod.rs index 4d14b6bf04..06672d9211 100644 --- a/src/tmi/mod.rs +++ b/src/tmi/mod.rs @@ -19,7 +19,7 @@ use serde::{Deserialize, Serialize}; /// /// Most [clients][crate::HttpClient] will be able to use the `'static` lifetime /// -/// ```rust,no_run +/// ```rust /// # use twitch_api2::{TmiClient}; pub mod surf {pub type Client = twitch_api2::client::DummyHttpClient;} /// pub struct MyStruct { /// twitch: TmiClient<'static, surf::Client>,