Struct vtubestudio::data::EventSubscriptionRequest
source · [−]pub struct EventSubscriptionRequest {
pub subscribe: bool,
pub event_name: Option<EnumString<ResponseType>>,
pub config: Option<OpaqueValue>,
}
Expand description
Subscribe or unsubscribe from events.
This request returns EventSubscriptionResponse
.
Fields
subscribe: bool
Set to true
to subscribe, false
to unsubscribe.
event_name: Option<EnumString<ResponseType>>
The event type.
config: Option<OpaqueValue>
Config for the event subscription.
Implementations
sourceimpl EventSubscriptionRequest
impl EventSubscriptionRequest
sourcepub fn subscribe<T>(config: &T) -> Result<Self, Error>where
T: EventConfig,
pub fn subscribe<T>(config: &T) -> Result<Self, Error>where
T: EventConfig,
Subscribe to a specific event type.
use vtubestudio::data::{EventSubscriptionRequest, TestEventConfig};
let req = EventSubscriptionRequest::subscribe(&TestEventConfig {
test_message_for_event: "text the event will return".to_owned(),
});
sourcepub fn unsubscribe<T>() -> Selfwhere
T: EventData,
pub fn unsubscribe<T>() -> Selfwhere
T: EventData,
Unsubscribe from a specific event type.
use vtubestudio::data::{EventSubscriptionRequest, TestEvent};
let req = EventSubscriptionRequest::unsubscribe::<TestEvent>();
sourcepub fn unsubscribe_all() -> Self
pub fn unsubscribe_all() -> Self
Unsubscribe from all events.
Trait Implementations
sourceimpl Clone for EventSubscriptionRequest
impl Clone for EventSubscriptionRequest
sourcefn clone(&self) -> EventSubscriptionRequest
fn clone(&self) -> EventSubscriptionRequest
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 moresourceimpl Debug for EventSubscriptionRequest
impl Debug for EventSubscriptionRequest
sourceimpl Default for EventSubscriptionRequest
impl Default for EventSubscriptionRequest
sourcefn default() -> EventSubscriptionRequest
fn default() -> EventSubscriptionRequest
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for EventSubscriptionRequest
impl<'de> Deserialize<'de> for EventSubscriptionRequest
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 Request for EventSubscriptionRequest
impl Request for EventSubscriptionRequest
type Response = EventSubscriptionResponse
type Response = EventSubscriptionResponse
The expected
Response
type for this request.sourceimpl Serialize for EventSubscriptionRequest
impl Serialize for EventSubscriptionRequest
Auto Trait Implementations
impl RefUnwindSafe for EventSubscriptionRequest
impl Send for EventSubscriptionRequest
impl Sync for EventSubscriptionRequest
impl Unpin for EventSubscriptionRequest
impl UnwindSafe for EventSubscriptionRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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