Struct twitch_api2::helix::search::SearchChannelsRequest [−][src]
#[non_exhaustive]pub struct SearchChannelsRequest { pub query: String, pub after: Option<Cursor>, pub first: Option<usize>, pub live_only: Option<bool>, }
This is supported on crate feature
helix
only.Query Parameters for 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: String
URL 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.
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 SearchChannelsRequest
[src]
impl SearchChannelsRequest
[src]pub fn builder() -> SearchChannelsRequestBuilder<((), (), (), ())>
[src]
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
.
Trait Implementations
impl Clone for SearchChannelsRequest
[src]
impl Clone for SearchChannelsRequest
[src]fn clone(&self) -> SearchChannelsRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for SearchChannelsRequest
[src]
impl<'de> Deserialize<'de> for SearchChannelsRequest
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Paginated for SearchChannelsRequest
[src]
impl Paginated for SearchChannelsRequest
[src]fn set_pagination(&mut self, cursor: Option<Cursor>)
[src]
impl PartialEq<SearchChannelsRequest> for SearchChannelsRequest
[src]
impl PartialEq<SearchChannelsRequest> for SearchChannelsRequest
[src]fn eq(&self, other: &SearchChannelsRequest) -> bool
[src]
fn ne(&self, other: &SearchChannelsRequest) -> bool
[src]
impl Request for SearchChannelsRequest
[src]
impl Request for SearchChannelsRequest
[src]type Response = Vec<Channel>
Response type. twitch’s response will deserialize to this.
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
const OPT_SCOPE: &'static [Scope]
[src]
fn query(&self) -> Result<String, Error>
[src]
fn get_uri(&self) -> Result<Uri, InvalidUri>
[src]
fn get_bare_uri() -> Result<Uri, InvalidUri>
[src]
impl RequestGet for SearchChannelsRequest
[src]
impl RequestGet for SearchChannelsRequest
[src]fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
[src]
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
fn parse_response(
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
[src]
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> 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,
[src]
request: Option<Self>,
uri: &Uri,
response: &str,
_status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
impl Serialize for SearchChannelsRequest
[src]
impl Serialize for SearchChannelsRequest
[src]Auto Trait Implementations
impl RefUnwindSafe for SearchChannelsRequest
impl RefUnwindSafe for SearchChannelsRequest
impl Send for SearchChannelsRequest
impl Send for SearchChannelsRequest
impl Sync for SearchChannelsRequest
impl Sync for SearchChannelsRequest
impl Unpin for SearchChannelsRequest
impl Unpin for SearchChannelsRequest
impl UnwindSafe for SearchChannelsRequest
impl UnwindSafe for SearchChannelsRequest
Blanket Implementations
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
impl<T> WithSubscriber for T
[src]pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,