Struct twitch_api2::helix::search::search_categories::SearchCategoriesRequest

#[non_exhaustive]pub struct SearchCategoriesRequest {
    pub query: String,
    pub after: Option<Cursor>,
    pub before: Option<Cursor>,
    pub first: Option<String>,
}

This is supported 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: String

URI encoded search query

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.

before: Option<Cursor>

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<String>

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

Implementations

impl SearchCategoriesRequest

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

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.

Trait Implementations

impl Clone for SearchCategoriesRequest

fn clone(&self) -> SearchCategoriesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchCategoriesRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchCategoriesRequest

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 PartialEq<SearchCategoriesRequest> for SearchCategoriesRequest

fn eq(&self, other: &SearchCategoriesRequest) -> bool

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

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

This method tests for !=.

impl Request for SearchCategoriesRequest

type Response = Vec<Category>

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

const PATH: &'static str

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

const SCOPE: &'static [Scope]

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope]

Optional scopes needed by this endpoint

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

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 create_request(
    &self,
    token: &str,
    client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>

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

fn parse_response(
    request: Option<Self>,
    uri: &Uri,
    response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse response. Override for different behavior

impl Serialize for SearchCategoriesRequest

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchCategoriesRequest