Struct aravis::Buffer

source · [−]

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

Implementations

source

impl Buffer

source

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.

pub fn chunk_data(&self, chunk_id: u64) -> Vec<u8>

Chunk data accessor.

pub fn frame_id(&self) -> u64

Gets the buffer frame id. For GigEVision devices, 0 is an invalid value.

pub fn image_height(&self) -> i32

Gets the image width. This function must only be called on buffer containing a BufferPayloadType::Image payload.

pub fn image_pixel_format(&self) -> PixelFormat

Gets the image pixel format. This function must only be called on buffer containing a BufferPayloadType::Image payload.

pub fn image_region(&self) -> (i32, i32, i32, i32 )

Gets the image region. This function must only be called on buffer containing a BufferPayloadType::Image payload.

Returns

pub fn image_width(&self) -> i32

Gets the image width. This function must only be called on buffer containing a BufferPayloadType::Image payload.

pub fn image_x(&self) -> i32

Gets the image x offset. This function must only be called on buffer containing a BufferPayloadType::Image payload.

pub fn image_y(&self) -> i32

Gets the image y offset. This function must only be called on buffer containing a BufferPayloadType::Image payload.

pub fn payload_type(&self) -> BufferPayloadType

Gets the buffer payload type.

pub fn status(&self) -> BufferStatus

Gets the buffer acquisition status.

pub fn system_timestamp(&self) -> u64

Gets the system timestamp for when the frame was received. Expressed in nanoseconds.

Returns

buffer system timestamp, in nanoseconds.

source

pub fn timestamp(&self) -> u64

Gets the buffer camera timestamp, expressed as nanoseconds. Not all devices provide reliable timestamp, which means sometimes its better to rely on the buffer completion host local time, or to use system_timestamp().

Returns

buffer timestamp, in nanoseconds.

source

pub fn has_chunks(&self) -> bool

Returns

true if self has a payload type that contains chunk data.

source

pub fn set_frame_id(&self, frame_id: u64)

Available on crate feature v0_8_3 only.

Sets the buffer frame id. For GigEVision devices, 0 is an invalid value.

`frame_id`

a guint64

source

pub fn set_system_timestamp(&self, timestamp_ns: u64)

Sets the system timestamp for when the frame was received. Expressed in nanoseconds.

`timestamp_ns`

a timestamp, expressed as nanoseconds

source

pub fn set_timestamp(&self, timestamp_ns: u64)

Sets the buffer timestamp, which allows to override the timpestamp set by the camera, which in some case is incorrect.

`timestamp_ns`

a timestamp, expressed as nanoseconds

source

impl Buffer

source

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.

source

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.

source

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.

source

pub fn data(&self) -> (*mut u8, usize )

Get a pointer to the raw data and the length of the buffer.

source

pub unsafe fn into_image(self) -> Result<DynamicImage, ImageError>

Convert the buffer into an image.

Safety

This function assumes the buffer is backed by a leaked box, such as created by Buffer::new_leaked_box.

This function takes ownership of the leaked box, so the memory will be freed when the resulting image is dropped.

Trait Implementations

source

impl Clone for Buffer

source

fn clone(&self) -> Self

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

source

impl Debug for Buffer

source

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

Formats the value using the given formatter. Read more

source

impl Display for Buffer

source

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

Formats the value using the given formatter. Read more

source

impl Hash for Buffer

source

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

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

source

impl Ord for Buffer

source

fn cmp(&self, other: &Self) -> 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

source

impl ParentClassIs for Buffer

type Parent = Object

source

impl<OT: ObjectType> PartialEq<OT> for Buffer

source

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

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

1.0.0 · source

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

This method tests for !=.

source

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

source

fn partial_cmp(&self, other: &OT) -> 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

source

impl StaticType for Buffer

source

fn static_type() -> Type

Returns the type identifier of Self.

source

impl Eq for Buffer

source

impl Send for Buffer

Auto Trait Implementations

impl RefUnwindSafe for Buffer

impl !Sync for Buffer

impl Unpin for Buffer

impl UnwindSafe for Buffer

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> Cast for T where
T: ObjectType,

source

fn upcast<T>(self) -> T where
T: ObjectType,
Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more

source

fn upcast_ref<T>(&self) -> &T where
T: ObjectType,
Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more

source

fn downcast<T>(self) -> Result<T, Self> where
T: ObjectType,
Self: CanDowncast<T>,

Tries to downcast to a subclass or interface implementor T. Read more

source

fn downcast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
Self: CanDowncast<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more

source

fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

source

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

source

unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,

Casts to T unconditionally. Read more

source

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,

Casts to &T unconditionally. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl IsSubclassableExt for U where
U: IsClass + ParentClassIs,

source

fn parent_class_init<T>(class: &mut Class) where
T: ObjectSubclass,
::Parent: IsSubclassable<T>,

source

fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
::Parent: IsSubclassable<T>,

source

impl<T> ObjectExt for T where
T: ObjectType,

source

fn is(&self) -> bool where
U: StaticType,

Returns true if the object is an instance of (can be cast to) T.

source

fn type_(&self) -> Type

Returns the type of the object.

source

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more

source

fn class(&self) -> &Class<T> where
T: IsClass,

Returns the class of the object.

source

fn class_of(&self) -> Option<&Class> where
U: IsClass,

Returns the class of the object in the given type T. Read more

source

fn interface(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface,

Returns the interface T of the object. Read more

source

fn try_set_property<V>(
 &self,
 property_name: &str,
 value: V
) -> Result<(), BoolError> where
 V: ToValue,

Similar to Self::set_property but fails instead of panicking.

source

fn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,

Sets the property property_name of the object to value value. Read more

source

fn try_set_property_from_value(
 &self,
 property_name: &str,
 value: &Value
) -> Result<(), BoolError>

Similar to Self::set_property but fails instead of panicking.

source

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more

source

fn try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue )]
) -> Result<(), BoolError>

Similar to Self::set_properties but fails instead of panicking.

source

fn set_properties(&self, property_values: &[(&str, &dyn ToValue )])

Sets multiple properties of the object at once. Read more

source

fn try_set_properties_from_value(
&self,
property_values: &[(&str, Value )]
) -> Result<(), BoolError>

Similar to Self::set_properties_from_value but fails instead of panicking.

source

fn set_properties_from_value(&self, property_values: &[(&str, Value )])

Sets multiple properties of the object at once. Read more

source

fn try_property<V>(&self, property_name: &str) -> Result<V, BoolError> where
V: 'static + for<'b> FromValue<'b>,

Similar to Self::property but fails instead of panicking.

source

fn property<V>(&self, property_name: &str) -> V where
V: 'static + for<'b> FromValue<'b>,

Gets the property property_name of the object and cast it to the type V. Read more

source

fn try_property_value(&self, property_name: &str) -> Result<Value, BoolError>

Similar to Self::property_value but fails instead of panicking.

source

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more

source

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more

source

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more

source

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.

source

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.

source

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more

source

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,

Set arbitrary data on this object with the given key. Read more

source

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more

source

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more

source

unsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,

Set arbitrary data on this object with the given key. Read more

source

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more

source

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more

source

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more

source

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.

source

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.

source

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.

source

fn try_connect<F>(
 &self,
 signal_name: &str,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

Similar to Self::connect but fails instead of panicking.

source

fn connect<F>(
 &self,
 signal_name: &str,
 after: bool,
 callback: F
) -> SignalHandlerId where
 F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

Connect to the signal signal_name on this object. Read more

source

fn try_connect_id<F>(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

Similar to Self::connect_id but fails instead of panicking.

source

fn connect_id<F>(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 callback: F
) -> SignalHandlerId where
 F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

Connect to the signal signal_id on this object. Read more

source

fn try_connect_local<F>(
 &self,
 signal_name: &str,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: 'static + Fn(&[Value ]) -> Option<Value>,

Similar to Self::connect_local but fails instead of panicking.

source

fn connect_local<F>(
 &self,
 signal_name: &str,
 after: bool,
 callback: F
) -> SignalHandlerId where
 F: 'static + Fn(&[Value ]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more

source

fn try_connect_local_id<F>(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: 'static + Fn(&[Value ]) -> Option<Value>,

Similar to Self::connect_local_id but fails instead of panicking.

source

fn connect_local_id<F>(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 callback: F
) -> SignalHandlerId where
 F: 'static + Fn(&[Value ]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more

source

unsafe fn try_connect_unsafe<F>(
 &self,
 signal_name: &str,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: Fn(&[Value ]) -> Option<Value>,

Similar to Self::connect_unsafe but fails instead of panicking.

source

unsafe fn connect_unsafe<F>(
 &self,
 signal_name: &str,
 after: bool,
 callback: F
) -> SignalHandlerId where
 F: Fn(&[Value ]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more

source

unsafe fn try_connect_unsafe_id<F>(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: Fn(&[Value ]) -> Option<Value>,

Similar to Self::connect_unsafe_id but fails instead of panicking.

source

fn try_connect_closure(
 &self,
 signal_name: &str,
 after: bool,
 closure: RustClosure
) -> Result<SignalHandlerId, BoolError>

Similar to Self::connect_closure but fails instead of panicking.

source

fn connect_closure(
    &self,
    signal_name: &str,
    after: bool,
    closure: RustClosure
) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more

source

fn try_connect_closure_id(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 closure: RustClosure
) -> Result<SignalHandlerId, BoolError>

Similar to Self::connect_closure_id but fails instead of panicking.

source

fn connect_closure_id(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 closure: RustClosure
) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more

source

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to Closure::invoke. Read more

source