Enum gstreamer::StateChangeReturn

#[must_use]
#[non_exhaustive]pub enum StateChangeReturn {
    Failure,
    Success,
    Async,
    NoPreroll,
    // some variants omitted
}

The possible return values from a state change function such as Element::set_state. Only StateChangeReturn::Failure is a real failure.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Failure

the state change failed

Success

the state change succeeded

Async

the state change will happen asynchronously

NoPreroll

the state change succeeded but the element cannot produce data in State::Paused. This typically happens with live sources.

Implementations

impl StateChangeReturn

pub fn into_result(self) -> Result<StateChangeSuccess, StateChangeError>

pub fn from_error(_: StateChangeError) -> Self

pub fn from_ok(v: StateChangeSuccess) -> Self

Trait Implementations

impl Clone for StateChangeReturn

fn clone(&self) -> StateChangeReturn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StateChangeReturn

impl Debug for StateChangeReturn

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

Formats the value using the given formatter.

impl Eq for StateChangeReturn

impl From<Result<StateChangeSuccess, StateChangeError>> for StateChangeReturn

fn from(res: Result<StateChangeSuccess, StateChangeError>) -> Self

Performs the conversion.

impl From<StateChangeError> for StateChangeReturn

fn from(value: StateChangeError) -> Self

Performs the conversion.

impl From<StateChangeSuccess> for StateChangeReturn

fn from(value: StateChangeSuccess) -> Self

Performs the conversion.

impl<'a> FromValue<'a> for StateChangeReturn

unsafe fn from_value(value: &Value) -> Self

Safety

impl<'a> FromValueOptional<'a> for StateChangeReturn

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

impl Hash for StateChangeReturn

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for StateChangeReturn

fn cmp(&self, other: &StateChangeReturn) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<StateChangeReturn> for StateChangeReturn

fn eq(&self, other: &StateChangeReturn) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StateChangeReturn) -> bool

This method tests for !=.

impl PartialOrd<StateChangeReturn> for StateChangeReturn

fn partial_cmp(&self, other: &StateChangeReturn) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &StateChangeReturn) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &StateChangeReturn) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &StateChangeReturn) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &StateChangeReturn) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SetValue for StateChangeReturn

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for StateChangeReturn

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for StateChangeReturn

impl StructuralPartialEq for StateChangeReturn