realsense_rust::kind

Enum Rs2Extension

#[repr(i32)]pub enum Rs2Extension {
Show 56 variants    ColorSensor = 42,
    MotionSensor = 43,
    FishEyeSensor = 44,
    DepthSensor = 7,
    DepthStereoSensor = 17,
    SoftwareSensor = 24,
    PoseSensor = 34,
    L500DepthSensor = 39,
    Tm2Sensor = 40,
    CalibratedSensor = 50,
    MaxUsableRangeSensor = 53,
    DebugStreamSensor = 54,
    VideoFrame = 8,
    MotionFrame = 9,
    CompositeFrame = 10,
    DepthFrame = 12,
    DisparityFrame = 18,
    PoseFrame = 20,
    Points = 11,
    DecimationFilter = 25,
    ThresholdFilter = 26,
    DisparityFilter = 27,
    SpatialFilter = 28,
    TemporalFilter = 29,
    HoleFillingFilter = 30,
    ZeroOrderFilter = 31,
    RecommendedFilters = 32,
    AutoCalibrationFilter = 48,
    SequenceIdFilter = 52,
    VideoProfile = 15,
    MotionProfile = 19,
    PoseProfile = 21,
    SoftwareDevice = 23,
    UpdateDevice = 38,
    AutoCalibratedDevice = 41,
    CalibrationChangeDevice = 55,
    AdvancedMode = 13,
    Record = 14,
    Playback = 16,
    Pose = 33,
    WheelOdometer = 35,
    GlobalTimer = 36,
    Updatable = 37,
    Tm2 = 22,
    Unknown = 0,
    Debug = 1,
    Info = 2,
    Motion = 3,
    Options = 4,
    Video = 5,
    Roi = 6,
    DepthHuffmanDecoder = 45,
    Serializable = 46,
    FirmwareLogger = 47,
    DeviceCalibration = 49,
    HdrMerge = 51,
}

Expand description

Enumeration of interface extensions

Rs2Extension is an enumeration type that lists all the possible underlying interfaces that librealsense2 types can be extended to. Most of the types in librealsense2 are pointers to opaque structs, and there is little in the way of type variety or distinction.

Instead, generic types are effectively type-tagged through the use of an extension enums which represent the true ontological distinction between e.g. two frames or two sensors.

Here, rather than try to separate these into different types at the Rust level, we do a simple mapping to the underlying C-enum values. The API does not try to expose these where possible and attempts to hide this behind traits.

Extensions as listed are effectively the “types” of underlying data in the librealsense2 system. However, there is only one extension enum, whereas there are plenty of categories of types available. We try to split these into sets of categories:

§Sensor extensions:

§Frame extensions:

§Filter (processing block) extensions:

§Profile extensions:

§Device extensions:

§Miscellaneous extensions:

Variants§

ColorSensor = 42

Color sensor

MotionSensor = 43

Motion sensor

FishEyeSensor = 44

Fisheye sensor

DepthSensor = 7

Depth sensor

DepthStereoSensor = 17

Depth stereo sensor

SoftwareSensor = 24

Software sensor

PoseSensor = 34

Pose sensor

L500DepthSensor = 39

L500 depth sensor

Tm2Sensor = 40

TM2 sensor

CalibratedSensor = 50

Calibrated sensor

MaxUsableRangeSensor = 53

Max usable range sensor

DebugStreamSensor = 54

Debug stream sensor

VideoFrame = 8

Video frame

MotionFrame = 9

Motion frame

CompositeFrame = 10

Composite frame

DepthFrame = 12

Depth frame

DisparityFrame = 18

Disparity frame

PoseFrame = 20

Pose frame

Points = 11

Points

DecimationFilter = 25

Decimation filter

ThresholdFilter = 26

Threshold filter

DisparityFilter = 27

Disparity filter

SpatialFilter = 28

Spatial filter

TemporalFilter = 29

Temporal filter

HoleFillingFilter = 30

Hole filling filter

ZeroOrderFilter = 31

Zero order filter

RecommendedFilters = 32

Recommended filters

AutoCalibrationFilter = 48

Auto-calibration filter

SequenceIdFilter = 52

Sequence ID filter

VideoProfile = 15

Video profile

MotionProfile = 19

Motion profile

PoseProfile = 21

Pose profile

SoftwareDevice = 23

Software device

UpdateDevice = 38

Update device

AutoCalibratedDevice = 41

Auto-calibration device

CalibrationChangeDevice = 55

Calibration change device

AdvancedMode = 13

Advanced mode

Record = 14

Record

Playback = 16

Playback

Pose = 33

Pose

WheelOdometer = 35

Wheel odometer

GlobalTimer = 36

Global timer

Updatable = 37

Updatable

Tm2 = 22

TM2

Unknown = 0

Unknown

Debug = 1

Debug

Info = 2

Info

Motion = 3

Motion

Options = 4

Options

Video = 5

Video

Roi = 6

ROI

DepthHuffmanDecoder = 45

Depth Huffman decoder

Serializable = 46

Serializable

FirmwareLogger = 47

Firmware logger

DeviceCalibration = 49

Device calibration

HdrMerge = 51

HDR merge

Trait Implementations§

impl Clone for Rs2Extension

fn clone(&self) -> Rs2Extension

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Rs2Extension

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

Formats the value using the given formatter. Read more

impl FromPrimitive for Rs2Extension

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned. Read more

impl Hash for Rs2Extension

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

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, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for Rs2Extension

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToPrimitive for Rs2Extension

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned. Read more

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned. Read more

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64. Read more

impl Copy for Rs2Extension

impl Eq for Rs2Extension

impl StructuralPartialEq for Rs2Extension

Auto Trait Implementations§

impl Freeze for Rs2Extension

impl RefUnwindSafe for Rs2Extension

impl Send for Rs2Extension

impl Sync for Rs2Extension

impl Unpin for Rs2Extension

impl UnwindSafe for Rs2Extension

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.