Struct gstreamer::BufferFlags

[+] Show declaration

pub struct BufferFlags { /* fields omitted */ }

[−] Expand description

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

Implementations

impl BufferFlags[−]

pub const LIVE: BufferFlags[−][−]

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

pub const DECODE_ONLY: BufferFlags[−][−]

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: BufferFlags[−][−]

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: BufferFlags[−][−]

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

pub const CORRUPTED: BufferFlags[−][−]

the buffer data is corrupted.

pub const MARKER: BufferFlags[−][−]

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: BufferFlags[−][−]

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

pub const GAP: BufferFlags[−][−]

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: BufferFlags[−][−]

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

pub const DELTA_UNIT: BufferFlags[−][−]

this unit cannot be decoded independently.

pub const TAG_MEMORY: BufferFlags[−][−]

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

pub const SYNC_AFTER: BufferFlags[−][−]

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

pub const NON_DROPPABLE: BufferFlags[−][−]

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. (Since: 1.14)

pub const fn empty() -> BufferFlags[−]

Returns an empty set of flags

pub const fn all() -> BufferFlags[−]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<BufferFlags>[−]

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) -> BufferFlags[−]

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> BufferFlags[−]

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

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: BufferFlags) -> bool[−]

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

pub const fn contains(&self, other: BufferFlags) -> bool[−]

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

pub fn insert(&mut self, other: BufferFlags)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: BufferFlags)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: BufferFlags)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: BufferFlags, value: bool)[−]

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

Trait Implementations

impl Binary for BufferFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl BitAnd<BufferFlags> for BufferFlags[+]

type Output = BufferFlags

The resulting type after applying the & operator.

fn bitand(self, other: BufferFlags) -> BufferFlags[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<BufferFlags> for BufferFlags[+]

fn bitand_assign(&mut self, other: BufferFlags)[−]

Disables all flags disabled in the set.

impl BitOr<BufferFlags> for BufferFlags[+]

type Output = BufferFlags

The resulting type after applying the | operator.

fn bitor(self, other: BufferFlags) -> BufferFlags[−]

Returns the union of the two sets of flags.

impl BitOrAssign<BufferFlags> for BufferFlags[+]

fn bitor_assign(&mut self, other: BufferFlags)[−]

Adds the set of flags.

impl BitXor<BufferFlags> for BufferFlags[+]

type Output = BufferFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: BufferFlags) -> BufferFlags[−]

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

impl BitXorAssign<BufferFlags> for BufferFlags[+]

fn bitxor_assign(&mut self, other: BufferFlags)[−]

Toggles the set of flags.

impl Clone for BufferFlags[+]

[+] Show hidden undocumented items

fn clone(&self) -> BufferFlags[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for BufferFlags

impl Debug for BufferFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BufferFlags[+]

[+] Show hidden undocumented items

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

Deserialize this value from the given Serde deserializer.

impl Eq for BufferFlags

impl Extend<BufferFlags> for BufferFlags[+]

[+] Show hidden undocumented items

fn extend<T: IntoIterator<Item = BufferFlags>>(&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[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = BufferFlags>>(iterator: T) -> BufferFlags[−]

Creates a value from an iterator.

impl<'a> FromValue<'a> for BufferFlags[+]

[+] Show hidden undocumented items

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

Safety

impl<'a> FromValueOptional<'a> for BufferFlags[+]

[+] Show hidden undocumented items

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

Safety

impl Hash for BufferFlags[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Not for BufferFlags[+]

type Output = BufferFlags

The resulting type after applying the ! operator.

fn not(self) -> BufferFlags[−]

Returns the complement of this set of flags.

impl Octal for BufferFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Ord for BufferFlags[+]

[+] Show hidden undocumented items

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

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

#[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<BufferFlags> for BufferFlags[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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: &BufferFlags) -> bool[−]

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

fn le(&self, other: &BufferFlags) -> bool[−]

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

fn gt(&self, other: &BufferFlags) -> bool[−]

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

fn ge(&self, other: &BufferFlags) -> bool[−]

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

impl Serialize for BufferFlags[+]

[+] Show hidden undocumented items

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

Serialize this value into the given Serde serializer.

impl SetValue for BufferFlags[+]

[+] Show hidden undocumented items

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

Safety

impl StaticType for BufferFlags[+]

[+] Show hidden undocumented items

fn static_type() -> Type[−]

Returns the type identifier of Self.

impl StructuralEq for BufferFlags

impl StructuralPartialEq for BufferFlags

impl Sub<BufferFlags> for BufferFlags[+]

type Output = BufferFlags

The resulting type after applying the - operator.

fn sub(self, other: BufferFlags) -> BufferFlags[−]

Returns the set difference of the two sets of flags.

impl SubAssign<BufferFlags> for BufferFlags[+]

fn sub_assign(&mut self, other: BufferFlags)[−]

Disables all flags enabled in the set.

impl UpperHex for BufferFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.