Enum gstreamer::FlowReturn

source · [−]

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

Expand description

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)

This enum is marked as 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 using GST_ELEMENT_ERROR() 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 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for FlowReturn

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

Formats the value using the given formatter. Read more

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

type Checker = GenericValueTypeChecker<Self>

Value type checker.

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

Get the contained value from a Value. Read more

impl Hash for FlowReturn

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for FlowReturn

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

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 ==. Read more

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. Read more

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

impl StaticType for FlowReturn

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for FlowReturn

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self. Read more

impl ValueType for FlowReturn

type Type = Self

Type to get the Type from. Read more

impl Copy for FlowReturn

impl Eq for FlowReturn

impl StructuralEq for FlowReturn

impl StructuralPartialEq for FlowReturn

Auto Trait Implementations

impl RefUnwindSafe for FlowReturn

impl Send for FlowReturn

impl Sync for FlowReturn

impl Unpin for FlowReturn

impl UnwindSafe for FlowReturn

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> StaticTypeExt for T where
T: StaticType,

pub fn ensure_type()

Ensures that the type has been registered with the type system.

impl<T> ToClosureReturnValue for T where
T: ToValue,

pub fn to_closure_return_value(&self) -> Option<Value>

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

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

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

impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,

pub fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> TryFromClosureReturnValue for T where
T: 'static + for<'a> FromValue<'a> + StaticType,

pub fn try_from_closure_return_value(v: Option<Value>) -> Result<T, BoolError>

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.

const: unstable · source

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

Performs the conversion.