[−][src]Trait realsense_rust::frame::GenericFrame

pub trait GenericFrame where
    Self: Sized, {
    fn ptr(&self) -> NonNull<rs2_frame>;

    unsafe fn take(self) -> NonNull<rs2_frame>;

    unsafe fn from_ptr(ptr: NonNull<rs2_frame>) -> Self;

    fn metadata(&self, kind: FrameMetaDataValue) -> RsResult<u64> { ... }

    fn number(&self) -> RsResult<u64> { ... }

    fn data_size(&self) -> RsResult<usize> { ... }

    fn timestamp(&self) -> RsResult<f64> { ... }

    fn timestamp_domain(&self) -> RsResult<TimestampDomain> { ... }

    fn data(&self) -> RsResult<&[u8]> { ... }

    fn sensor(&self) -> RsResult<Sensor<Any>> { ... }

    fn stream_profile(&self) -> RsResult<StreamProfile<Any>> { ... }

    fn try_clone(&self) -> RsResult<Self> { ... }
}

The trait provides common methods on frames of all kinds.

Required methods

fn ptr(&self) -> NonNull<rs2_frame>

unsafe fn take(self) -> NonNull<rs2_frame>

Destruct and return the raw pointer. It is intended for internal use only.

Safety

You have to manage the lifetime of internal pointer by calling this method.

unsafe fn from_ptr(ptr: NonNull<rs2_frame>) -> Self

Construct from a raw pointer. It is intended for internal use only.

Safety

You have to ensure the pointer is valid.

Loading content...

Provided methods

fn metadata(&self, kind: FrameMetaDataValue) -> RsResult<u64>

Obtains the metadata of frame.

fn number(&self) -> RsResult<u64>

Gets frame number.

fn data_size(&self) -> RsResult<usize>

Gets raw data size in bytes.

fn timestamp(&self) -> RsResult<f64>

Gets the timestamp.

fn timestamp_domain(&self) -> RsResult<TimestampDomain>

Gets the domain of timestamp.

fn data(&self) -> RsResult<&[u8]>

Gets raw data bytes in frame.

fn sensor(&self) -> RsResult<Sensor<Any>>

Gets the relating sensor instance.

fn stream_profile(&self) -> RsResult<StreamProfile<Any>>

Gets the relating stream profile.

fn try_clone(&self) -> RsResult<Self>

Loading content...

Implementors

impl<Kind> GenericFrame for Frame<Kind> where
    Kind: FrameKind, [src]

Loading content...