Struct gstreamer::BufferFlags

pub struct BufferFlags { /* private fields */ }

A set of buffer flags used to describe properties of a Buffer.

Implementations

impl BufferFlags

pub const LIVE: Self

the buffer is live data and should be discarded in the PAUSED state.

pub const DECODE_ONLY: Self

the buffer contains data that should be dropped because it will be clipped against the segment boundaries or because it does not contain data that should be shown to the user.

pub const DISCONT: Self

the buffer marks a data discontinuity in the stream. This typically occurs after a seek or a dropped buffer from a live or network source.

pub const RESYNC: Self

the buffer timestamps might have a discontinuity and this buffer is a good point to resynchronize.

pub const CORRUPTED: Self

the buffer data is corrupted.

pub const MARKER: Self

the buffer contains a media specific marker. for video this is the end of a frame boundary, for audio this is the start of a talkspurt.

pub const HEADER: Self

the buffer contains header information that is needed to decode the following data.

pub const GAP: Self

the buffer has been created to fill a gap in the stream and contains media neutral data (elements can switch to optimized code path that ignores the buffer content).

pub const DROPPABLE: Self

the buffer can be dropped without breaking the stream, for example to reduce bandwidth.

pub const DELTA_UNIT: Self

this unit cannot be decoded independently.

pub const TAG_MEMORY: Self

this flag is set when memory of the buffer is added/removed

pub const SYNC_AFTER: Self

Elements which write to disk or permanent storage should ensure the data is synced after writing the contents of this buffer.

pub const NON_DROPPABLE: Self

This is supported on crate feature v1_14 only.

This buffer is important and should not be dropped.

This can be used to mark important buffers, e.g. to flag RTP packets carrying keyframes or codec setup data for RTP Forward Error Correction purposes, or to prevent still video frames from being dropped by elements due to QoS.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for BufferFlags

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

Formats the value using the given formatter.

impl BitAnd<BufferFlags> for BufferFlags

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

Returns the intersection between the two sets of flags.

type Output = Self

The resulting type after applying the & operator.

impl BitAndAssign<BufferFlags> for BufferFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<BufferFlags> for BufferFlags

fn bitor(self, other: BufferFlags) -> Self

Returns the union of the two sets of flags.

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<BufferFlags> for BufferFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<BufferFlags> for BufferFlags

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

Returns the left flags, but with all the right flags toggled.

type Output = Self

The resulting type after applying the ^ operator.

impl BitXorAssign<BufferFlags> for BufferFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for BufferFlags

fn clone(&self) -> BufferFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BufferFlags

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BufferFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Extend<BufferFlags> for BufferFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<BufferFlags> for BufferFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl<'a> FromValue<'a> for BufferFlags

type Checker = GenericValueTypeChecker<Self>

Value type checker.

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

Get the contained value from a Value.

impl Hash for BufferFlags

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 LowerHex for BufferFlags

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

Formats the value using the given formatter.

impl Not for BufferFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Self

The resulting type after applying the ! operator.

impl Octal for BufferFlags

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

Formats the value using the given formatter.

impl Ord for BufferFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<BufferFlags> for BufferFlags

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

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

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

This method tests for !=.

impl PartialOrd<BufferFlags> for BufferFlags

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

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

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

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

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

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

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

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

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

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

impl Serialize for BufferFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StaticType for BufferFlags

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<BufferFlags> for BufferFlags

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

Returns the set difference of the two sets of flags.

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<BufferFlags> for BufferFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl ToValue for BufferFlags

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for BufferFlags

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

Formats the value using the given formatter.

impl ValueType for BufferFlags

type Type = Self

Type to get the Type from.

impl Copy for BufferFlags

impl Eq for BufferFlags

impl StructuralEq for BufferFlags

impl StructuralPartialEq for BufferFlags