Struct realsense_rust::pipeline::Pipeline

pub struct Pipeline<State> where
    State: PipelineState,  { /* fields omitted */ }

Represents the data pipeline from a RealSense device.

Implementations

impl Pipeline<Inactive>

pub fn new() -> Result<Self>

Creates an instance.

pub fn from_context(context: Context) -> Result<Self>

Consumes a context and creates an instance.

pub fn start(self, config: impl Into<Option<Config>>) -> Result<ActivePipeline>

Start the pipeline with optional config.

The method consumes inactive pipeline itself, and returns the started pipeine.

pub async fn start_async(
    self,
    config: impl Into<Option<Config>>
) -> Result<ActivePipeline>

Start the pipeline asynchronously. It is analogous to Pipeline::start.

pub fn into_raw_parts(self) -> (*mut rs2_pipeline, *mut rs2_context)

Unpack the pipeline into raw pointers.

It returns the raw pointer along with the context pointer that the pipeline depends on.

pub unsafe fn from_raw_parts(
    pipeline_ptr: *mut rs2_pipeline,
    context_ptr: *mut rs2_context
) -> Self

Construct an inactive pipeline from raw pointers.

It assumes the pipeline pointers is built atop from the context pointer.

impl Pipeline<Active>

pub fn profile(&self) -> &PipelineProfile

Gets the active profile of pipeline.

pub fn wait(
    &mut self,
    timeout: impl Into<Option<Duration>>
) -> Result<Option<CompositeFrame>>

Block until the next frame is available.

When the timeout is set, it returns Ok(Some(frame)) if the frame is available, or returns Ok(None) when timeout occurs.

If the timeout is None, it waits indefinitely before the next frame.

pub fn try_wait(&mut self) -> Result<Option<CompositeFrame>>

Poll if next frame is immediately available.

Unlike Pipeline::start, the method does not block and returns None if next from is not available.

pub async fn wait_async(
    &mut self,
    timeout: impl Into<Option<Duration>>
) -> Result<Option<CompositeFrame>>

Wait for the next frame asynchronously.

The method is analogous to Pipeline::wait.

When the timeout is set, it returns Ok(Some(frame)) if the frame is available, or returns Ok(None) when timeout occurs.

If the timeout is None, it waits indefinitely before the next frame.

pub fn stop(self) -> Result<InactivePipeline>

Stop the pipeline.

This method consumes the pipeline instance and returns pipeline markered inactive.

pub fn into_raw_parts(
    self
) -> (*mut rs2_pipeline, *mut rs2_context, *mut rs2_pipeline_profile, Option<*mut rs2_config>)

Unpack the pipeline into raw pointers.

After calling this method, you have to take care of their lifetime manually.

pub unsafe fn from_raw_parts(
    pipeline_ptr: *mut rs2_pipeline,
    context_ptr: *mut rs2_context,
    profile_ptr: *mut rs2_pipeline_profile,
    config_ptr: Option<*mut rs2_config>
) -> Self

Construct an active pipeline from raw pointers.

It assumes the pipeline pointer is built from the context pointer, and profile pointer is the active profile of the pipeline.

Trait Implementations

impl<State: Debug> Debug for Pipeline<State> where
    State: PipelineState, 

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

Formats the value using the given formatter.

impl<State> Drop for Pipeline<State> where
    State: PipelineState, 

fn drop(&mut self)

Executes the destructor for this type.

impl<State> Send for Pipeline<State> where
    State: PipelineState,