Struct twitch_api::helix::users::GetUsersFollowsRequest

#[non_exhaustive]
pub struct GetUsersFollowsRequest<'a> {
    pub after: Option<Cow<'a, CursorRef>>,
    pub first: Option<usize>,
    pub from_id: Option<Cow<'a, UserIdRef>>,
    pub to_id: Option<Cow<'a, UserIdRef>>,
}

Available on crate feature helix only.

Query Parameters for Get Users Follows

get-users-follows

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

after: Option<Cow<'a, CursorRef>>

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<Cow<'a, UserIdRef>>

User ID. The request returns information about users who are being followed by the from_id user.

to_id: Option<Cow<'a, UserIdRef>>

User ID. The request returns information about users who are following the to_id user.

Implementations

impl<'a> GetUsersFollowsRequest<'a>

pub fn builder() -> GetUsersFollowsRequestBuilder<'a, ((), (), (), ())>

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.

impl<'a> GetUsersFollowsRequest<'a>

pub fn following(from_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self

Get the broadcasters that from_id is following

pub fn followers(to_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self

Get the followers of to_id

Examples found in repository

src/helix/client/client_ext.rs (line 414)

↕

    pub async fn get_total_followers_from_id<'b, T>(
        &'a self,
        to_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        token: &T,
    ) -> Result<i64, ClientError<'a, C>>
    where
        T: TwitchToken + ?Sized,
    {
        let resp = self
            .req_get(
                helix::users::GetUsersFollowsRequest::followers(to_id),
                token,
            )
            .await?;

        Ok(resp.data.total)
    }

pub fn follows(
    user_id: impl IntoCow<'a, UserIdRef> + 'a,
    broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a
) -> Self

Check if user follows a specific broadcaster

pub fn empty() -> Self

Returns an empty GetUsersFollowsRequest

Notes

This is not a valid request, it needs to be filled with other fields

Examples found in repository

src/helix/endpoints/users/get_users_follows.rs (line 65)

≺ ≻↕

    pub fn following(from_id: impl types::IntoCow<'a, types::UserIdRef> + 'a) -> Self {
        Self {
            from_id: Some(from_id.to_cow()),
            ..Self::empty()
        }
    }

    /// Get the followers of `to_id`
    pub fn followers(to_id: impl types::IntoCow<'a, types::UserIdRef> + 'a) -> Self {
        Self {
            to_id: Some(to_id.to_cow()),
            ..Self::empty()
        }
    }

    /// Check if user follows a specific broadcaster
    pub fn follows(
        user_id: impl types::IntoCow<'a, types::UserIdRef> + 'a,
        broadcaster_id: impl types::IntoCow<'a, types::UserIdRef> + 'a,
    ) -> Self {
        Self {
            from_id: Some(user_id.to_cow()),
            to_id: Some(broadcaster_id.to_cow()),
            ..Self::empty()
        }
    }

src/helix/client/client_ext.rs (line 215)

↕

    pub fn get_follow_relationships<T>(
        &'a self,
        to_id: impl Into<Option<&'a types::UserIdRef>>,
        from_id: impl Into<Option<&'a types::UserIdRef>>,
        token: &'a T,
    ) -> std::pin::Pin<
        Box<
            dyn futures::Stream<Item = Result<helix::users::FollowRelationship, ClientError<'a, C>>>
                + Send
                + 'a,
        >,
    >
    where
        T: TwitchToken + Send + Sync + ?Sized,
    {
        let mut req = helix::users::GetUsersFollowsRequest::empty();
        req.to_id = to_id.into().map(Cow::Borrowed);
        req.from_id = from_id.into().map(Cow::Borrowed);

        make_stream(req, token, self, |s| {
            std::collections::VecDeque::from(s.follow_relationships)
        })
    }

Trait Implementations

impl<'a> Clone for GetUsersFollowsRequest<'a>

fn clone(&self) -> GetUsersFollowsRequest<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for GetUsersFollowsRequest<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for GetUsersFollowsRequest<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Paginated for GetUsersFollowsRequest<'_>

fn set_pagination(&mut self, cursor: Option<Cursor>)

Should returns the current pagination cursor.

impl<'a> PartialEq<GetUsersFollowsRequest<'a>> for GetUsersFollowsRequest<'a>

fn eq(&self, other: &GetUsersFollowsRequest<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Request for GetUsersFollowsRequest<'_>

type Response = UsersFollows

Response type. twitch’s response will deserialize to this.

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

const PATH: &'static str = "users/follows"

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

fn query(&self) -> Result<String, SerializeError>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

impl RequestGet for GetUsersFollowsRequest<'_>

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.

fn create_request(
    &self,
    token: &str,
    client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>

Create a http::Request from this Request in your client

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.

impl<'a> Serialize for GetUsersFollowsRequest<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for GetUsersFollowsRequest<'a>

impl<'a> StructuralEq for GetUsersFollowsRequest<'a>

impl<'a> StructuralPartialEq for GetUsersFollowsRequest<'a>