Struct realsense_rust::pipeline::Pipeline

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

Represents the data pipeline from a RealSense device.

Methods

impl Pipeline<Inactive>

pub fn new() -> RsResult<Self>

Creates an instance.

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

Consumes a context and creates an instance.

pub fn start(self, config: Option<Config>) -> RsResult<Pipeline<Active>>

Start the pipeline with optional config.

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

pub async fn start_async(
    self,
    config: Option<Config>
) -> RsResult<Pipeline<Active>>

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

impl Pipeline<Active>

pub fn profile(&self) -> &PipelineProfile

Gets the profile of pipeline.

pub fn wait(&mut self, timeout: Option<Duration>) -> RsResult<Frame<Composite>>

Block and wait for next frame.

pub fn try_wait(&mut self) -> RsResult<Option<Frame<Composite>>>

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: Option<Duration>
) -> RsResult<Frame<Composite>>

Wait for frame asynchronously. It is analogous to Pipeline::wait

pub fn stop(self) -> RsResult<Pipeline<Inactive>>

Stop the pipeline.

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

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,