Struct obws::client::Outputs

source ·

pub struct Outputs<'a> { /* private fields */ }

Expand description

API functions related to outputs.

Implementations

source

impl<'a> Outputs<'a>

source

pub async fn list(&self) -> Result<Vec<Output>>

Gets the list of available outputs.

source

pub async fn status(&self, name: &str) -> Result<OutputStatus>

Gets the status of an output.

source

pub async fn toggle(&self, name: &str) -> Result<bool>

Toggles the status of an output.

source

pub async fn start(&self, name: &str) -> Result<()>

Starts an output.

source

pub async fn stop(&self, name: &str) -> Result<()>

Stops an output.

source

pub async fn settings<T>(&self, name: &str) -> Result<T>where
T: DeserializeOwned,

Gets the settings of an output.

source

pub async fn set_settings<T>(&self, name: &str, settings: T) -> Result<()>where
T: Serialize,

Sets the settings of an output.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Outputs<'a>

impl<'a> Send for Outputs<'a>

impl<'a> Sync for Outputs<'a>

impl<'a> Unpin for Outputs<'a>

impl<'a> !UnwindSafe for Outputs<'a>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct obws::client::Outputs

Implementations

impl<'a> Outputs<'a>

pub async fn list(&self) -> Result<Vec<Output>>

pub async fn status(&self, name: &str) -> Result<OutputStatus>

pub async fn toggle(&self, name: &str) -> Result<bool>

pub async fn start(&self, name: &str) -> Result<()>

pub async fn stop(&self, name: &str) -> Result<()>

pub async fn settings<T>(&self, name: &str) -> Result<T>where T: DeserializeOwned,

pub async fn set_settings<T>(&self, name: &str, settings: T) -> Result<()>where T: Serialize,

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Outputs<'a>

impl<'a> Send for Outputs<'a>

impl<'a> Sync for Outputs<'a>

impl<'a> Unpin for Outputs<'a>

impl<'a> !UnwindSafe for Outputs<'a>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn settings<T>(&self, name: &str) -> Result<T>where
T: DeserializeOwned,

pub async fn set_settings<T>(&self, name: &str, settings: T) -> Result<()>where
T: Serialize,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,