gst_client::resources

Struct PipelineElement

pub struct PipelineElement { /* private fields */ }

Expand description

Performs requests to pipelines/{name}/elements/{element} endpoints

Implementations§

impl PipelineElement

pub async fn property(&self, property: &str) -> Result<SuccessResponse, Error>

Performs GET pipelines/{name}/elements/ {element}/properties/{property} API request, returning the parsed gstd_types::SuccessResponse

§Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn set_property( &self, property: &str, value: &str, ) -> Result<SuccessResponse, Error>

Performs PUT pipelines/{name}/elements/ {element}/properties/{property}?name={value} API request, returning the parsed gstd_types::SuccessResponse

§Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn signal_connect( &self, signal: &str, ) -> Result<SuccessResponse, Error>

Performs GET pipelines/{name}/ elements/{element}/signals/{signal}/callback API request, returning the parsed gstd_types::SuccessResponse

§Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn signal_disconnect( &self, signal: &str, ) -> Result<SuccessResponse, Error>

Performs GET pipelines/{name}/ elements/{element}/signals/{signal}/disconnect API request, returning the parsed gstd_types::SuccessResponse

§Errors

If API request cannot be performed, or fails. See Error for details.

pub async fn set_signal_timeout( &self, signal: &str, timeout: &str, ) -> Result<SuccessResponse, Error>

Performs PUT pipelines/{name}/ elements/{element}/signals/{signal}/timeout?name={timeout} API request, returning the parsed gstd_types::SuccessResponse

§Arguments

signal - signal to connect

§Errors

If API request cannot be performed, or fails. See Error for details.

Trait Implementations§

impl Clone for PipelineElement

fn clone(&self) -> PipelineElement

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for PipelineElement

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for PipelineElement

impl !RefUnwindSafe for PipelineElement

impl Send for PipelineElement

impl Sync for PipelineElement

impl Unpin for PipelineElement

impl !UnwindSafe for PipelineElement

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,