Struct aravis::Buffer

pub struct Buffer(_, _);

Methods

impl Buffer

pub fn new_allocate(size: usize) -> Buffer

Creates a new buffer for the storage of the video stream images. The data space is allocated by this function, and will be freed when the buffer is destroyed.

size

payload size

Returns

a new Buffer object

impl Buffer

pub unsafe fn new_preallocated(data: *mut u8, len: usize) -> Self

Create an Aravis buffer from a pre-allocated raw buffer.

The created buffer has no registered user data or destroy callback, so management of the underlying buffer has to be done externally. The buffer can be identified later when it is returned by a stream only byt the data pointer.

Safety

The resulting buffer borrows the data, but it carries no lifetime. The user has to ensure the buffer stays valid.

impl Buffer

pub fn new_leaked_box(len: usize) -> Self

Create a new buffer backed by a leaked Box<[u8]>.

The buffer can later be turned into an image using [Self::into_image]. If the buffer is dropped without taking ownership of the data again, the memory is leaked.

pub fn new_leaked_image(
    format: PixelFormat,
    width: usize,
    height: usize
) -> Self

Create a new buffer for an image of the specified format and dimensions, backed by a leaked Box<[u8]>.

The buffer can later be turned into an image using [Self::into_image]. If the buffer is dropped without taking ownership of the data again, the memory is leaked.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

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 Display for Buffer

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

Formats the value using the given formatter.

impl Eq for Buffer

impl Hash for Buffer

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 Buffer

fn cmp(&self, other: &Buffer) -> 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<T: ObjectType> PartialEq<T> for Buffer

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for Buffer

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 StaticType for Buffer

fn static_type() -> Type

Returns the type identifier of Self.