Struct twitch_api2::helix::points::GetCustomRewardRequest
source · [−]#[non_exhaustive]pub struct GetCustomRewardRequest {
pub broadcaster_id: UserId,
pub id: Vec<RewardId>,
pub only_manageable_rewards: Option<bool>,
}
helix
only.Expand description
Query Parameters for Get Custom Reward
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.broadcaster_id: UserId
Provided broadcaster_id must match the user_id in the auth token
id: Vec<RewardId>
When used, this parameter filters the results and only returns reward objects for the Custom Rewards with matching ID. Maximum: 50
only_manageable_rewards: Option<bool>
When set to true, only returns custom rewards that the calling client_id can manage. Defaults false.
Implementations
sourceimpl GetCustomRewardRequest
impl GetCustomRewardRequest
sourcepub fn builder() -> GetCustomRewardRequestBuilder<((), (), ())>
pub fn builder() -> GetCustomRewardRequestBuilder<((), (), ())>
Create a builder for building GetCustomRewardRequest
.
On the builder, call .broadcaster_id(...)
, .id(...)
(optional), .only_manageable_rewards(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetCustomRewardRequest
.
Trait Implementations
sourceimpl Clone for GetCustomRewardRequest
impl Clone for GetCustomRewardRequest
sourcefn clone(&self) -> GetCustomRewardRequest
fn clone(&self) -> GetCustomRewardRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetCustomRewardRequest
impl Debug for GetCustomRewardRequest
sourceimpl<'de> Deserialize<'de> for GetCustomRewardRequest
impl<'de> Deserialize<'de> for GetCustomRewardRequest
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<GetCustomRewardRequest> for GetCustomRewardRequest
impl PartialEq<GetCustomRewardRequest> for GetCustomRewardRequest
sourcefn eq(&self, other: &GetCustomRewardRequest) -> bool
fn eq(&self, other: &GetCustomRewardRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetCustomRewardRequest) -> bool
fn ne(&self, other: &GetCustomRewardRequest) -> bool
This method tests for !=
.
sourceimpl Request for GetCustomRewardRequest
impl Request for GetCustomRewardRequest
type Response = Vec<CustomReward, Global>
type Response = Vec<CustomReward, Global>
Response type. twitch’s response will deserialize to this.
sourceconst PATH: &'static str = "channel_points/custom_rewards"
const PATH: &'static str = "channel_points/custom_rewards"
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
sourceconst SCOPE: &'static [Scope] = &[twitch_oauth2::scopes::Scope::ChannelReadRedemptions]
const SCOPE: &'static [Scope] = &[twitch_oauth2::scopes::Scope::ChannelReadRedemptions]
twitch_oauth2
only.Scopes needed by this endpoint
sourceconst OPT_SCOPE: &'static [Scope] = &[]
const OPT_SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Optional scopes needed by this endpoint
sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
Defines layout of the url parameters.
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
Returns full URI for the request, including query parameters.
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
Returns bare URI for the request, NOT including query parameters.
sourceimpl RequestGet for GetCustomRewardRequest
impl RequestGet for GetCustomRewardRequest
sourcefn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
Create a http::Request
from this Request
in your client
sourcefn parse_response<B: Into<Bytes>>(
request: Option<Self>,
uri: &Uri,
response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError> where
Self: Sized,
fn parse_response<B: Into<Bytes>>(
request: Option<Self>,
uri: &Uri,
response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError> where
Self: Sized,
Parse response. Read more
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError> where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError> where
Self: Sized,
Parse a response string into the response.
sourceimpl Serialize for GetCustomRewardRequest
impl Serialize for GetCustomRewardRequest
impl StructuralPartialEq for GetCustomRewardRequest
Auto Trait Implementations
impl RefUnwindSafe for GetCustomRewardRequest
impl Send for GetCustomRewardRequest
impl Sync for GetCustomRewardRequest
impl Unpin for GetCustomRewardRequest
impl UnwindSafe for GetCustomRewardRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more