Enum gstreamer::FlowReturn

#[must_use]
#[non_exhaustive]pub enum FlowReturn {
    CustomSuccess2,
    CustomSuccess1,
    CustomSuccess,
    Ok,
    NotLinked,
    Flushing,
    Eos,
    NotNegotiated,
    Error,
    NotSupported,
    CustomError,
    CustomError1,
    CustomError2,
    // some variants omitted
}

The result of passing data to a pad.

Note that the custom return values should not be exposed outside of the element scope.

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.

CustomSuccess2

Pre-defined custom success code.

CustomSuccess1

Pre-defined custom success code (define your custom success code to this to avoid compiler warnings).

CustomSuccess

Elements can use values starting from this (and higher) to define custom success codes.

Ok

Data passing was ok.

NotLinked

Pad is not linked.

Flushing

Pad is flushing.

Eos

Pad is EOS.

NotNegotiated

Pad is not negotiated.

Error

Some (fatal) error occurred. Element generating this error should post an error message with more details.

NotSupported

This operation is not supported.

CustomError

Elements can use values starting from this (and lower) to define custom error codes.

CustomError1

Pre-defined custom error code (define your custom error code to this to avoid compiler warnings).

CustomError2

Pre-defined custom error code.

Implementations

impl FlowReturn

pub fn into_result(self) -> Result<FlowSuccess, FlowError>

pub fn into_result_value<T, F: FnOnce() -> T>(
    self,
    func: F
) -> Result<T, FlowError>

pub fn from_error(v: FlowError) -> Self

pub fn from_ok(v: FlowSuccess) -> Self

Trait Implementations

impl Clone for FlowReturn

fn clone(&self) -> FlowReturn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FlowReturn

impl Debug for FlowReturn

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

Formats the value using the given formatter.

impl Eq for FlowReturn

impl<'a> From<&'a FlowError> for FlowReturn

fn from(err: &FlowError) -> FlowReturn

Performs the conversion.

impl From<FlowError> for FlowReturn

fn from(value: FlowError) -> Self

Performs the conversion.

impl From<FlowError> for FlowReturn

fn from(err: FlowError) -> Self

Performs the conversion.

impl From<FlowSuccess> for FlowReturn

fn from(value: FlowSuccess) -> Self

Performs the conversion.

impl From<Result<FlowSuccess, FlowError>> for FlowReturn

fn from(res: Result<FlowSuccess, FlowError>) -> Self

Performs the conversion.

impl<'a> FromValue<'a> for FlowReturn

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

Safety

impl<'a> FromValueOptional<'a> for FlowReturn

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

Safety

impl Hash for FlowReturn

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 FlowReturn

fn cmp(&self, other: &FlowReturn) -> 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<FlowReturn> for FlowReturn

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

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

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

This method tests for !=.

impl PartialOrd<FlowReturn> for FlowReturn

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

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

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

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

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

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

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

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

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

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

impl SetValue for FlowReturn

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

Safety

impl StaticType for FlowReturn

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for FlowReturn

impl StructuralPartialEq for FlowReturn