Struct SearchChannelsRequest

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

Available on crate feature helix only.

Query Parameters for Search Channels

search-channels

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>

URL 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.

first: Option<usize>

Maximum number of objects to return. Maximum: 100 Default: 20

live_only: Option<bool>

Filter results for live streams only. Default: false

Implementations

impl<'a> SearchChannelsRequest<'a>

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

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

impl<'a> SearchChannelsRequest<'a>

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

Search channels with the following query.

pub const fn live_only(self, live_only: bool) -> Self

Get live streams only

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

Set amount of results returned per page.

Trait Implementations

impl<'a> Clone for SearchChannelsRequest<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SearchChannelsRequest<'a>

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

Formats the value using the given formatter.

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

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

Should returns the current pagination cursor.

impl<'a> PartialEq for SearchChannelsRequest<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Request for SearchChannelsRequest<'_>

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

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

const SCOPE: Validator

Available on crate feature twitch_oauth2 only.

Scopes needed for this endpoint

type Response = Vec<Channel>

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

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 SearchChannelsRequest<'_>

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.

fn parse_inner_response( request: Option<Self>, uri: &Uri, response: &str, status: StatusCode, ) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>

where Self: Sized,

Parse a response string into the response.

impl<'a> Serialize for SearchChannelsRequest<'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 SearchChannelsRequest<'a>

impl<'a> StructuralPartialEq for SearchChannelsRequest<'a>