Struct twitch_api2::helix::schedule::update_channel_stream_schedule::UpdateChannelStreamScheduleRequest
source · [−]#[non_exhaustive]pub struct UpdateChannelStreamScheduleRequest {
pub broadcaster_id: UserId,
pub is_vacation_enabled: Option<bool>,
pub vacation_start_time: Option<Timestamp>,
pub vacation_end_time: Option<Timestamp>,
pub timezone: Option<String>,
}
helix
only.Expand description
Query Parameters for Update Channel Stream Schedule
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.broadcaster_id: UserId
User ID of the broadcaster who owns the channel streaming schedule. Provided broadcaster_id must match the user_id in the user OAuth token.
is_vacation_enabled: Option<bool>
Indicates if Vacation Mode is enabled. Set to true to add a vacation or false to remove vacation from the channel streaming schedule.
vacation_start_time: Option<Timestamp>
Start time for vacation specified in RFC3339 format. Required if is_vacation_enabled is set to true.
vacation_end_time: Option<Timestamp>
End time for vacation specified in RFC3339 format. Required if is_vacation_enabled is set to true.
timezone: Option<String>
The timezone for when the vacation is being scheduled using the IANA time zone database format. Required if is_vacation_enabled is set to true.
Implementations
sourceimpl UpdateChannelStreamScheduleRequest
impl UpdateChannelStreamScheduleRequest
sourcepub fn builder(
) -> UpdateChannelStreamScheduleRequestBuilder<((), (), (), (), ())>
pub fn builder(
) -> UpdateChannelStreamScheduleRequestBuilder<((), (), (), (), ())>
Create a builder for building UpdateChannelStreamScheduleRequest
.
On the builder, call .broadcaster_id(...)
, .is_vacation_enabled(...)
(optional), .vacation_start_time(...)
(optional), .vacation_end_time(...)
(optional), .timezone(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of UpdateChannelStreamScheduleRequest
.
Trait Implementations
sourceimpl Clone for UpdateChannelStreamScheduleRequest
impl Clone for UpdateChannelStreamScheduleRequest
sourcefn clone(&self) -> UpdateChannelStreamScheduleRequest
fn clone(&self) -> UpdateChannelStreamScheduleRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'de> Deserialize<'de> for UpdateChannelStreamScheduleRequest
impl<'de> Deserialize<'de> for UpdateChannelStreamScheduleRequest
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<UpdateChannelStreamScheduleRequest> for UpdateChannelStreamScheduleRequest
impl PartialEq<UpdateChannelStreamScheduleRequest> for UpdateChannelStreamScheduleRequest
sourcefn eq(&self, other: &UpdateChannelStreamScheduleRequest) -> bool
fn eq(&self, other: &UpdateChannelStreamScheduleRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UpdateChannelStreamScheduleRequest) -> bool
fn ne(&self, other: &UpdateChannelStreamScheduleRequest) -> bool
This method tests for !=
.
sourceimpl Request for UpdateChannelStreamScheduleRequest
impl Request for UpdateChannelStreamScheduleRequest
type Response = UpdateChannelStreamSchedule
type Response = UpdateChannelStreamSchedule
Response type. twitch’s response will deserialize to this.
sourceconst PATH: &'static str = "schedule/settings"
const PATH: &'static str = "schedule/settings"
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
sourceconst SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelManageSchedule]
const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelManageSchedule]
twitch_oauth2
only.Scopes needed by this endpoint
sourceconst OPT_SCOPE: &'static [Scope] = &[]
const OPT_SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Optional scopes needed by this endpoint
sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
Defines layout of the url parameters.
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
Returns full URI for the request, including query parameters.
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
Returns bare URI for the request, NOT including query parameters.
sourceimpl RequestPatch for UpdateChannelStreamScheduleRequest
impl RequestPatch for UpdateChannelStreamScheduleRequest
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestPatchError> where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestPatchError> where
Self: Sized,
Parse a response string into the response.
sourcefn create_request(
&self,
body: Self::Body,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
fn create_request(
&self,
body: Self::Body,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
Create a http::Request
from this Request
in your client
impl StructuralPartialEq for UpdateChannelStreamScheduleRequest
Auto Trait Implementations
impl RefUnwindSafe for UpdateChannelStreamScheduleRequest
impl Send for UpdateChannelStreamScheduleRequest
impl Sync for UpdateChannelStreamScheduleRequest
impl Unpin for UpdateChannelStreamScheduleRequest
impl UnwindSafe for UpdateChannelStreamScheduleRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more