Struct gstreamer::buffer::Buffer

#[repr(transparent)]
pub struct Buffer { /* private fields */ }

Implementations

impl Buffer

pub unsafe fn from_glib_none(ptr: *const GstBuffer) -> Self

pub unsafe fn from_glib_full(ptr: *const GstBuffer) -> Self

pub unsafe fn from_glib_borrow(ptr: *const GstBuffer) -> Borrowed<Self>

pub unsafe fn replace_ptr(&mut self, ptr: *mut GstBuffer)

pub fn make_mut(&mut self) -> &mut BufferRef

pub fn get_mut(&mut self) -> Option<&mut BufferRef>

pub fn is_writable(&self) -> bool

pub fn upcast(self) -> MiniObject

impl Buffer

pub fn new() -> Self

Creates a newly allocated buffer without any data.

Returns

the new Buffer.

pub fn with_size(size: usize) -> Result<Self, BoolError>

pub fn from_mut_slice<T: AsMut<[u8]> + Send + 'static>(slice: T) -> Self

pub fn from_slice<T: AsRef<[u8]> + Send + 'static>(slice: T) -> Self

pub fn into_mapped_buffer_readable(self) -> Result<MappedBuffer<Readable>, Self>

Fills info with the GstMapInfo of all merged memory blocks in self.

flags describe the desired access of the memory. When flags is GST_MAP_WRITE, self should be writable (as returned from gst_buffer_is_writable()).

When self is writable but the memory isn’t, a writable copy will automatically be created and returned. The readonly copy of the buffer memory will then also be replaced with this writable copy.

The memory in info should be unmapped with gst_buffer_unmap() after usage.

flags

flags for the mapping

Returns

true if the map succeeded and info contains valid data.

info

info about the mapping

pub fn into_mapped_buffer_writable(self) -> Result<MappedBuffer<Writable>, Self>

pub fn into_cursor_readable(self) -> BufferCursor<Readable>

pub fn into_cursor_writable(self) -> Result<BufferCursor<Writable>, BoolError>

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

Appends all the memory from buf2 to self. The result buffer will contain a concatenation of the memory of self and buf2.

buf2

the second source Buffer to append.

Returns

the new Buffer that contains the memory of the two source buffers.

Methods from Deref<Target = BufferRef>

pub fn as_ptr(&self) -> *const GstBuffer

pub fn as_mut_ptr(&self) -> *mut GstBuffer

pub fn copy(&self) -> Buffer

pub fn upcast_ref(&self) -> &MiniObjectRef

pub fn map_readable(&self) -> Result<BufferMap<'_, Readable>, BoolError>

pub fn copy_region(
    &self,
    flags: BufferCopyFlags,
    offset: usize,
    size: Option<usize>
) -> Result<Buffer, BoolError>

pub fn copy_into(
    &self,
    dest: &mut BufferRef,
    flags: BufferCopyFlags,
    offset: usize,
    size: Option<usize>
) -> Result<(), BoolError>

pub fn copy_to_slice(&self, offset: usize, slice: &mut [u8]) -> Result<(), usize>

pub fn copy_deep(&self) -> Result<Buffer, BoolError>

pub fn size(&self) -> usize

pub fn maxsize(&self) -> usize

pub fn offset(&self) -> u64

pub fn offset_end(&self) -> u64

pub fn pts(&self) -> Option<ClockTime>

pub fn dts(&self) -> Option<ClockTime>

pub fn dts_or_pts(&self) -> Option<ClockTime>

pub fn duration(&self) -> Option<ClockTime>

pub fn flags(&self) -> BufferFlags

pub fn meta<T: MetaAPI>(&self) -> Option<MetaRef<'_, T>>

pub fn iter_meta<T: MetaAPI>(&self) -> MetaIter<'_, T>

pub fn foreach_meta<F: FnMut(MetaRef<'_, Meta>) -> ControlFlow<(), ()>>(
    &self,
    func: F
) -> bool

pub fn find_memory(
    &self,
    offset: usize,
    size: Option<usize>
) -> Option<(u32, u32, usize)>

pub fn all_memory(&self) -> Option<Memory>

pub fn memory(&self, idx: u32) -> Option<Memory>

pub fn memory_range(&self, idx: u32, length: Option<u32>) -> Option<Memory>

pub fn is_all_memory_writable(&self) -> bool

pub fn is_memory_range_writable(&self, idx: u32, length: Option<u16>) -> bool

pub fn n_memory(&self) -> u32

pub fn peek_memory(&self, idx: u32) -> &MemoryRef

pub fn iter_memories(&self) -> Iter<'_>

pub fn iter_memories_owned(&self) -> IterOwned<'_>

pub fn as_cursor_readable(&self) -> BufferRefCursor<&BufferRef>

Trait Implementations

impl AsRef<BufferRef> for Buffer

fn as_ref(&self) -> &BufferRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<BufferRef> for Buffer

fn borrow(&self) -> &BufferRef

Immutably borrows from an owned value.

impl Clone for Buffer

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Buffer

type Target = BufferRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Buffer

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.

impl Extend<Buffer> for BufferListRef

fn extend<T: IntoIterator<Item = Buffer>>(&mut self, iter: 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<const N: usize> From<[Memory; N]> for Buffer

fn from(value: [Memory; N]) -> Self

Converts to this type from the input type.

impl From<Buffer> for BufferList

fn from(value: Buffer) -> Self

Converts to this type from the input type.

impl From<Buffer> for Value

fn from(v: Buffer) -> Value

Converts to this type from the input type.

impl From<Memory> for Buffer

fn from(value: Memory) -> Self

Converts to this type from the input type.

impl FromGlibContainerAsVec<*mut GstBuffer, *const *mut GstBuffer> for Buffer

unsafe fn from_glib_none_num_as_vec(
    ptr: *const *mut GstBuffer,
    num: usize
) -> Vec<Self>

unsafe fn from_glib_container_num_as_vec(
    _: *const *mut GstBuffer,
    _: usize
) -> Vec<Self>

unsafe fn from_glib_full_num_as_vec(
    _: *const *mut GstBuffer,
    _: usize
) -> Vec<Self>

impl FromGlibContainerAsVec<*mut GstBuffer, *mut *mut GstBuffer> for Buffer

unsafe fn from_glib_none_num_as_vec(
    ptr: *mut *mut GstBuffer,
    num: usize
) -> Vec<Self>

unsafe fn from_glib_container_num_as_vec(
    ptr: *mut *mut GstBuffer,
    num: usize
) -> Vec<Self>

unsafe fn from_glib_full_num_as_vec(
    ptr: *mut *mut GstBuffer,
    num: usize
) -> Vec<Self>

impl FromGlibPtrArrayContainerAsVec<*mut GstBuffer, *const *mut GstBuffer> for Buffer

unsafe fn from_glib_none_as_vec(ptr: *const *mut GstBuffer) -> Vec<Self>

unsafe fn from_glib_container_as_vec(_: *const *mut GstBuffer) -> Vec<Self>

unsafe fn from_glib_full_as_vec(_: *const *mut GstBuffer) -> Vec<Self>

impl FromGlibPtrArrayContainerAsVec<*mut GstBuffer, *mut *mut GstBuffer> for Buffer

unsafe fn from_glib_none_as_vec(ptr: *mut *mut GstBuffer) -> Vec<Self>

unsafe fn from_glib_container_as_vec(ptr: *mut *mut GstBuffer) -> Vec<Self>

unsafe fn from_glib_full_as_vec(ptr: *mut *mut GstBuffer) -> Vec<Self>

impl FromGlibPtrBorrow<*const GstBuffer> for Buffer

unsafe fn from_glib_borrow(ptr: *const GstBuffer) -> Borrowed<Self>

Safety

impl FromGlibPtrBorrow<*mut GstBuffer> for Buffer

unsafe fn from_glib_borrow(ptr: *mut GstBuffer) -> Borrowed<Self>

Safety

impl FromGlibPtrFull<*const GstBuffer> for Buffer

unsafe fn from_glib_full(ptr: *const GstBuffer) -> Self

Safety

impl FromGlibPtrFull<*mut GstBuffer> for Buffer

unsafe fn from_glib_full(ptr: *mut GstBuffer) -> Self

Safety

impl FromGlibPtrNone<*const GstBuffer> for Buffer

unsafe fn from_glib_none(ptr: *const GstBuffer) -> Self

Safety

impl FromGlibPtrNone<*mut GstBuffer> for Buffer

unsafe fn from_glib_none(ptr: *mut GstBuffer) -> Self

Safety

impl FromIterator<Buffer> for BufferList

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

Creates a value from an iterator.

impl FromIterator<Memory> for Buffer

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

Creates a value from an iterator.

impl<'a> FromValue<'a> for &'a Buffer

type Checker = GenericValueTypeOrNoneChecker<&'a Buffer>

Value type checker.

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

Get the contained value from a Value.

impl<'a> FromValue<'a> for Buffer

type Checker = GenericValueTypeOrNoneChecker<Buffer>

Value type checker.

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

Get the contained value from a Value.

impl GlibPtrDefault for Buffer

type GlibType = *mut GstBuffer

impl IntoGlibPtr<*mut GstBuffer> for Buffer

unsafe fn into_glib_ptr(self) -> *mut GstBuffer

Transfer: full.

impl IsMiniObject for Buffer

type RefType = BufferRef

type FfiType = GstBuffer

impl PartialEq<Buffer> for Buffer

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Buffer> for BufferRef

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<BufferRef> for Buffer

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Buffer

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StaticType for Buffer

fn static_type() -> Type

Returns the type identifier of Self.

impl<'a> ToGlibContainerFromSlice<'a, *const *mut GstBuffer> for Buffer

type Storage = (PhantomData<&'a [Buffer]>, Option<Vec<*mut GstBuffer, Global>>)

fn to_glib_none_from_slice(
    t: &'a [Buffer]
) -> (*const *mut GstBuffer, Self::Storage)

fn to_glib_container_from_slice(
    _: &'a [Buffer]
) -> (*const *mut GstBuffer, Self::Storage)

fn to_glib_full_from_slice(_: &[Buffer]) -> *const *mut GstBuffer

impl<'a> ToGlibContainerFromSlice<'a, *mut *mut GstBuffer> for Buffer

type Storage = (PhantomData<&'a [Buffer]>, Option<Vec<*mut GstBuffer, Global>>)

fn to_glib_none_from_slice(
    t: &'a [Buffer]
) -> (*mut *mut GstBuffer, Self::Storage)

fn to_glib_container_from_slice(
    t: &'a [Buffer]
) -> (*mut *mut GstBuffer, Self::Storage)

fn to_glib_full_from_slice(t: &[Buffer]) -> *mut *mut GstBuffer

impl<'a> ToGlibPtr<'a, *const GstBuffer> for Buffer

type Storage = PhantomData<&'a Buffer>

fn to_glib_none(&'a self) -> Stash<'a, *const GstBuffer, Self>

Transfer: none.

fn to_glib_full(&self) -> *const GstBuffer

Transfer: full.

fn to_glib_container(&'a self) -> Stash<'a, P, Self>

Transfer: container.

impl<'a> ToGlibPtr<'a, *mut GstBuffer> for Buffer

type Storage = PhantomData<&'a Buffer>

fn to_glib_none(&'a self) -> Stash<'a, *mut GstBuffer, Self>

Transfer: none.

fn to_glib_full(&self) -> *mut GstBuffer

Transfer: full.

fn to_glib_container(&'a self) -> Stash<'a, P, Self>

Transfer: container.

impl<'a> ToGlibPtrMut<'a, *mut GstBuffer> for Buffer

type Storage = PhantomData<&'a mut Buffer>

fn to_glib_none_mut(&'a mut self) -> StashMut<'_, *mut GstBuffer, Self>

Transfer: none.

impl ToValue for Buffer

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ToValueOptional for Buffer

fn to_value_optional(s: Option<&Self>) -> Value

Convert an Option to a Value.

impl ValueType for Buffer

type Type = Buffer

Type to get the Type from.

impl Eq for Buffer

impl Send for Buffer

impl Sync for Buffer

impl TransparentPtrType for Buffer

impl ValueTypeOptional for Buffer