Struct twitch_api2::helix::eventsub::GetEventSubSubscriptionsRequest
source · [−]#[non_exhaustive]pub struct GetEventSubSubscriptionsRequest {
pub status: Option<Status>,
pub after: Option<Cursor>,
pub first: Option<usize>,
}
helix
and eventsub
only.Expand description
Query Parameters for Get EventSub Subscriptions
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.status: Option<Status>
Include this parameter to filter subscriptions by their status.
after: Option<Cursor>
Cursor for forward pagination
first: Option<usize>
Maximum number of objects to return. Maximum: 100. Default: 20.
Implementations
sourceimpl GetEventSubSubscriptionsRequest
impl GetEventSubSubscriptionsRequest
sourcepub fn builder() -> GetEventSubSubscriptionsRequestBuilder<((), (), ())>
pub fn builder() -> GetEventSubSubscriptionsRequestBuilder<((), (), ())>
Create a builder for building GetEventSubSubscriptionsRequest
.
On the builder, call .status(...)
(optional), .after(...)
(optional), .first(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetEventSubSubscriptionsRequest
.
Trait Implementations
sourceimpl Clone for GetEventSubSubscriptionsRequest
impl Clone for GetEventSubSubscriptionsRequest
sourcefn clone(&self) -> GetEventSubSubscriptionsRequest
fn clone(&self) -> GetEventSubSubscriptionsRequest
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 Paginated for GetEventSubSubscriptionsRequest
impl Paginated for GetEventSubSubscriptionsRequest
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<GetEventSubSubscriptionsRequest> for GetEventSubSubscriptionsRequest
impl PartialEq<GetEventSubSubscriptionsRequest> for GetEventSubSubscriptionsRequest
sourcefn eq(&self, other: &GetEventSubSubscriptionsRequest) -> bool
fn eq(&self, other: &GetEventSubSubscriptionsRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetEventSubSubscriptionsRequest) -> bool
fn ne(&self, other: &GetEventSubSubscriptionsRequest) -> bool
This method tests for !=
.
sourceimpl Request for GetEventSubSubscriptionsRequest
impl Request for GetEventSubSubscriptionsRequest
type Response = EventSubSubscriptions
type Response = EventSubSubscriptions
Response type. twitch’s response will deserialize to this.
sourceconst PATH: &'static str = "eventsub/subscriptions"
const PATH: &'static str = "eventsub/subscriptions"
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
sourceconst SCOPE: &'static [Scope] = &[]
const SCOPE: &'static [Scope] = &[]
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 GetEventSubSubscriptionsRequest
impl RequestGet for GetEventSubSubscriptionsRequest
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
Parse a response string into the response.
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
impl StructuralPartialEq for GetEventSubSubscriptionsRequest
Auto Trait Implementations
impl RefUnwindSafe for GetEventSubSubscriptionsRequest
impl Send for GetEventSubSubscriptionsRequest
impl Sync for GetEventSubSubscriptionsRequest
impl Unpin for GetEventSubSubscriptionsRequest
impl UnwindSafe for GetEventSubSubscriptionsRequest
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