Struct twitch_api::helix::search::search_categories::SearchCategoriesRequest

#[non_exhaustive]
pub struct SearchCategoriesRequest<'a> {
    pub query: Cow<'a, str>,
    pub after: Option<Cow<'a, CursorRef>>,
    pub before: Option<Cow<'a, CursorRef>>,
    pub first: Option<usize>,
}

Available on crate feature helix only.

Query Parameters for Search Categories

search-categories

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.

query: Cow<'a, str>

URI encoded search query

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.

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

Cursor for backward 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>

Number of values to be returned per page. Limit: 100. Default: 20.

Implementations

impl<'a> SearchCategoriesRequest<'a>

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

Create a builder for building SearchCategoriesRequest. On the builder, call .query(...), .after(...)(optional), .before(...)(optional), .first(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SearchCategoriesRequest.

impl<'a> SearchCategoriesRequest<'a>

pub fn query(query: impl Into<Cow<'a, str>>) -> Self

Search categories with the following query.

Examples found in repository

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

↕

    pub fn search_categories<T>(
        &'a self,
        query: impl Into<&'a str>,
        token: &'a T,
    ) -> std::pin::Pin<
        Box<dyn futures::Stream<Item = Result<helix::search::Category, ClientError<'a, C>>> + 'a>,
    >
    where
        T: TwitchToken + Send + Sync + ?Sized,
    {
        let req = helix::search::SearchCategoriesRequest::query(query.into()).first(100);
        make_stream(req, token, self, std::collections::VecDeque::from)
    }

pub fn first(self, first: usize) -> Self

Set amount of results returned per page.

Examples found in repository

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

↕

    pub fn search_categories<T>(
        &'a self,
        query: impl Into<&'a str>,
        token: &'a T,
    ) -> std::pin::Pin<
        Box<dyn futures::Stream<Item = Result<helix::search::Category, ClientError<'a, C>>> + 'a>,
    >
    where
        T: TwitchToken + Send + Sync + ?Sized,
    {
        let req = helix::search::SearchCategoriesRequest::query(query.into()).first(100);
        make_stream(req, token, self, std::collections::VecDeque::from)
    }

Trait Implementations

impl<'a> Clone for SearchCategoriesRequest<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SearchCategoriesRequest<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for SearchCategoriesRequest<'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 SearchCategoriesRequest<'_>

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

Should returns the current pagination cursor.

impl<'a> PartialEq<SearchCategoriesRequest<'a>> for SearchCategoriesRequest<'a>

fn eq(&self, other: &SearchCategoriesRequest<'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 SearchCategoriesRequest<'_>

type Response = Vec<TwitchCategory, Global>

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

const PATH: &'static str = "search/categories"

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

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional 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 SearchCategoriesRequest<'_>

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 SearchCategoriesRequest<'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 SearchCategoriesRequest<'a>

impl<'a> StructuralEq for SearchCategoriesRequest<'a>

impl<'a> StructuralPartialEq for SearchCategoriesRequest<'a>