Struct twitch_api2::helix::users::get_users_follows::GetUsersFollowsRequest
source · [−]#[non_exhaustive]pub struct GetUsersFollowsRequest {
pub after: Option<Cursor>,
pub first: Option<usize>,
pub from_id: Option<UserId>,
pub to_id: Option<UserId>,
}
helix
only.Expand description
Query Parameters for Get Users Follows
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.after: Option<Cursor>
Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
first: Option<usize>
Maximum number of objects to return. Maximum: 100. Default: 20.
from_id: Option<UserId>
User ID. The request returns information about users who are being followed by the from_id user.
to_id: Option<UserId>
User ID. The request returns information about users who are following the to_id user.
Implementations
sourceimpl GetUsersFollowsRequest
impl GetUsersFollowsRequest
sourcepub fn builder() -> GetUsersFollowsRequestBuilder<((), (), (), ())>
pub fn builder() -> GetUsersFollowsRequestBuilder<((), (), (), ())>
Create a builder for building GetUsersFollowsRequest
.
On the builder, call .after(...)
(optional), .first(...)
(optional), .from_id(...)
(optional), .to_id(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetUsersFollowsRequest
.
Trait Implementations
sourceimpl Clone for GetUsersFollowsRequest
impl Clone for GetUsersFollowsRequest
sourcefn clone(&self) -> GetUsersFollowsRequest
fn clone(&self) -> GetUsersFollowsRequest
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 GetUsersFollowsRequest
impl Debug for GetUsersFollowsRequest
sourceimpl<'de> Deserialize<'de> for GetUsersFollowsRequest
impl<'de> Deserialize<'de> for GetUsersFollowsRequest
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 GetUsersFollowsRequest
impl Paginated for GetUsersFollowsRequest
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<GetUsersFollowsRequest> for GetUsersFollowsRequest
impl PartialEq<GetUsersFollowsRequest> for GetUsersFollowsRequest
sourcefn eq(&self, other: &GetUsersFollowsRequest) -> bool
fn eq(&self, other: &GetUsersFollowsRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetUsersFollowsRequest) -> bool
fn ne(&self, other: &GetUsersFollowsRequest) -> bool
This method tests for !=
.
sourceimpl Request for GetUsersFollowsRequest
impl Request for GetUsersFollowsRequest
type Response = UsersFollows
type Response = UsersFollows
Response type. twitch’s response will deserialize to this.
sourceconst OPT_SCOPE: &'static [Scope] = &[]
const OPT_SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Optional scopes needed by this endpoint
sourceconst PATH: &'static str = "users/follows"
const PATH: &'static str = "users/follows"
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
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 GetUsersFollowsRequest
impl RequestGet for GetUsersFollowsRequest
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
sourceimpl Serialize for GetUsersFollowsRequest
impl Serialize for GetUsersFollowsRequest
impl StructuralPartialEq for GetUsersFollowsRequest
Auto Trait Implementations
impl RefUnwindSafe for GetUsersFollowsRequest
impl Send for GetUsersFollowsRequest
impl Sync for GetUsersFollowsRequest
impl Unpin for GetUsersFollowsRequest
impl UnwindSafe for GetUsersFollowsRequest
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