Struct twitch_api2::helix::points::get_custom_reward_redemption::GetCustomRewardRedemptionRequest
source · [−]#[non_exhaustive]pub struct GetCustomRewardRedemptionRequest {
pub broadcaster_id: UserId,
pub reward_id: RewardId,
pub status: Option<CustomRewardRedemptionStatus>,
pub after: Option<Cursor>,
pub first: Option<usize>,
}
helix
only.Expand description
Query Parameters for Get Custom Reward Redemption
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
reward_id: RewardId
When ID is not provided, this parameter returns paginated Custom Reward Redemption objects for redemptions of the Custom Reward with ID reward_id
status: Option<CustomRewardRedemptionStatus>
When id is not provided, this param is required and filters the paginated Custom Reward Redemption objects for redemptions with the matching status. Can be one of UNFULFILLED, FULFILLED or CANCELED
after: Option<Cursor>
Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. This applies only to queries without ID. If an ID is specified, it supersedes any cursor/offset combinations. The cursor value specified here is from the pagination response field of a prior query.
first: Option<usize>
Number of results to be returned when getting the paginated Custom Reward Redemption objects for a reward. Limit: 50. Default: 20.
Implementations
sourceimpl GetCustomRewardRedemptionRequest
impl GetCustomRewardRedemptionRequest
sourcepub fn builder(
) -> GetCustomRewardRedemptionRequestBuilder<((), (), (), (), ())>
pub fn builder(
) -> GetCustomRewardRedemptionRequestBuilder<((), (), (), (), ())>
Create a builder for building GetCustomRewardRedemptionRequest
.
On the builder, call .broadcaster_id(...)
, .reward_id(...)
, .status(...)
(optional), .after(...)
(optional), .first(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetCustomRewardRedemptionRequest
.
Trait Implementations
sourceimpl Clone for GetCustomRewardRedemptionRequest
impl Clone for GetCustomRewardRedemptionRequest
sourcefn clone(&self) -> GetCustomRewardRedemptionRequest
fn clone(&self) -> GetCustomRewardRedemptionRequest
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<'de> Deserialize<'de> for GetCustomRewardRedemptionRequest
impl<'de> Deserialize<'de> for GetCustomRewardRedemptionRequest
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 Paginated for GetCustomRewardRedemptionRequest
impl Paginated for GetCustomRewardRedemptionRequest
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
Should returns the current pagination cursor. Read more
sourceimpl PartialEq<GetCustomRewardRedemptionRequest> for GetCustomRewardRedemptionRequest
impl PartialEq<GetCustomRewardRedemptionRequest> for GetCustomRewardRedemptionRequest
sourcefn eq(&self, other: &GetCustomRewardRedemptionRequest) -> bool
fn eq(&self, other: &GetCustomRewardRedemptionRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetCustomRewardRedemptionRequest) -> bool
fn ne(&self, other: &GetCustomRewardRedemptionRequest) -> bool
This method tests for !=
.
sourceimpl Request for GetCustomRewardRedemptionRequest
impl Request for GetCustomRewardRedemptionRequest
type Response = Vec<CustomRewardRedemption, Global>
type Response = Vec<CustomRewardRedemption, Global>
Response type. twitch’s response will deserialize to this.
sourceconst PATH: &'static str = "channel_points/custom_rewards/redemptions"
const PATH: &'static str = "channel_points/custom_rewards/redemptions"
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 GetCustomRewardRedemptionRequest
impl RequestGet for GetCustomRewardRedemptionRequest
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.
impl StructuralPartialEq for GetCustomRewardRedemptionRequest
Auto Trait Implementations
impl RefUnwindSafe for GetCustomRewardRedemptionRequest
impl Send for GetCustomRewardRedemptionRequest
impl Sync for GetCustomRewardRedemptionRequest
impl Unpin for GetCustomRewardRedemptionRequest
impl UnwindSafe for GetCustomRewardRedemptionRequest
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