Enum rosrust::MsgValue

pub enum MsgValue {
    Bool(bool),
    I8(i8),
    I16(i16),
    I32(i32),
    I64(i64),
    U8(u8),
    U16(u16),
    U32(u32),
    U64(u64),
    F32(f32),
    F64(f64),
    String(String),
    Time(Time),
    Duration(Duration),
    Array(Vec<Value>),
    Message(HashMap<String, Value>),
}

Represents an arbitrary ROS message or value in it.

Variants

Bool(bool)

Represents bool.

I8(i8)

Represents int8 or byte.

I16(i16)

Represents int16.

I32(i32)

Represents int32.

I64(i64)

Represents int64.

U8(u8)

Represents uint8 or char.

U16(u16)

Represents uint16.

U32(u32)

Represents uint32.

U64(u64)

Represents uint64.

F32(f32)

Represents float32.

F64(f64)

Represents float64.

String(String)

Represents string.

Time(Time)

Represents time.

Duration(Duration)

Represents duration.

Array(Vec<Value>)

Represents some_type[] or some_type[length].

For example: float32[64], geometry_msgs/Point[].

Message(HashMap<String, Value>)

Represents an embedded message.

Implementations

impl Value

pub fn as_bool(&self) -> Option<bool>

Returns the content if Value is a bool.

Examples

assert_eq!(Value::Bool(true).as_bool(), Some(true));
assert_eq!(Value::Bool(false).as_bool(), Some(false));
assert!(Value::U32(12).as_bool().is_none());

pub fn as_i8(&self) -> Option<i8>

Returns the content if Value is an i8.

Examples

assert_eq!(Value::I8(12).as_i8(), Some(12));
assert!(Value::U32(12).as_i8().is_none());

pub fn as_i16(&self) -> Option<i16>

Returns the content if Value is an i16.

Examples

assert_eq!(Value::I16(12).as_i16(), Some(12));
assert!(Value::U32(12).as_i16().is_none());

pub fn as_i32(&self) -> Option<i32>

Returns the content if Value is an i32.

Examples

assert_eq!(Value::I32(12).as_i32(), Some(12));
assert!(Value::U32(12).as_i32().is_none());

pub fn as_i64(&self) -> Option<i64>

Returns the content if Value is an i64.

Examples

assert_eq!(Value::I64(12).as_i64(), Some(12));
assert!(Value::U32(12).as_i64().is_none());

pub fn as_u8(&self) -> Option<u8>

Returns the content if Value is a u8.

Examples

assert_eq!(Value::U8(12).as_u8(), Some(12));
assert!(Value::U32(12).as_u8().is_none());

pub fn as_u16(&self) -> Option<u16>

Returns the content if Value is a u16.

Examples

assert_eq!(Value::U16(12).as_u16(), Some(12));
assert!(Value::U32(12).as_u16().is_none());

pub fn as_u32(&self) -> Option<u32>

Returns the content if Value is a u32.

Examples

assert_eq!(Value::U32(12).as_u32(), Some(12));
assert!(Value::U16(12).as_u32().is_none());

pub fn as_u64(&self) -> Option<u64>

Returns the content if Value is a u64.

Examples

assert_eq!(Value::U64(12).as_u64(), Some(12));
assert!(Value::U32(12).as_u64().is_none());

pub fn as_f32(&self) -> Option<f32>

Returns the content if Value is an f32.

Examples

assert_eq!(Value::F32(12.0).as_f32(), Some(12.0));
assert!(Value::U32(12).as_f32().is_none());

pub fn as_f64(&self) -> Option<f64>

Returns the content if Value is an f64.

Examples

assert_eq!(Value::F64(12.0).as_f64(), Some(12.0));
assert!(Value::U32(12).as_f64().is_none());

pub fn as_str(&self) -> Option<&str>

Returns a &str if Value is a String.

Examples

assert_eq!(Value::String("foo".into()).as_str(), Some("foo"));
assert!(Value::U32(12).as_str().is_none());

pub fn try_into_string(self) -> Option<String>

Returns the content if Value is a String.

Examples

assert_eq!(Value::String("foo".into()).try_into_string(), Some("foo".into()));
assert!(Value::U32(12).try_into_string().is_none());

pub fn as_time(&self) -> Option<Time>

Returns the content if Value is a Time struct.

Examples

assert_eq!(
    Value::Time(Time::from_nanos(120)).as_time(),
    Some(Time::from_nanos(120)),
);
assert!(Value::U32(12).as_time().is_none());

pub fn as_duration(&self) -> Option<Duration>

Returns the content if Value is a Duration struct.

Examples

assert_eq!(
    Value::Duration(Duration::from_nanos(120)).as_duration(),
    Some(Duration::from_nanos(120)),
);
assert!(Value::U32(12).as_duration().is_none());

pub fn as_slice(&self) -> Option<&[Value]>

Returns a reference to the content if Value is an array.

Examples

assert_eq!(
    Value::Array(vec![1u32.into(), 2u32.into(), 3u32.into()]).as_slice(),
    Some(&[Value::U32(1), Value::U32(2), Value::U32(3)][..]),
);
assert!(Value::U32(12).as_slice().is_none());

pub fn try_into_vec(self) -> Option<Vec<Value>>

Returns the content if Value is an array.

Examples

assert_eq!(
    Value::Array(vec![1u32.into(), 2u32.into(), 3u32.into()]).try_into_vec(),
    Some(vec![Value::U32(1), Value::U32(2), Value::U32(3)]),
);
assert!(Value::U32(12).try_into_vec().is_none());

pub fn as_map(&self) -> Option<&HashMap<String, Value>>

Returns a reference to the content if Value is a message.

Examples

let mut data = HashMap::<String, Value>::new();
data.insert("foo".into(), true.into());
data.insert("bar".into(), false.into());
assert_eq!(Value::Message(data.clone()).as_map(), Some(&data));
assert!(Value::U32(12).as_map().is_none());

pub fn try_into_map(self) -> Option<HashMap<String, Value>>

Returns the content if Value is a message.

Examples

let mut data = HashMap::<String, Value>::new();
data.insert("foo".into(), true.into());
data.insert("bar".into(), false.into());
assert_eq!(Value::Message(data.clone()).try_into_map(), Some(data));
assert!(Value::U32(12).try_into_map().is_none());

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<__D>( __deserializer: __D, ) -> Result<Value, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl<T, const L: usize> From<[T; L]> for Value

where T: Into<Value>,

fn from(v: [T; L]) -> Value

Converts to this type from the input type.

impl From<Duration> for Value

fn from(v: Duration) -> Value

Converts to this type from the input type.

impl From<HashMap<String, Value>> for Value

fn from(v: HashMap<String, Value>) -> Value

Converts to this type from the input type.

impl From<String> for Value

fn from(v: String) -> Value

Converts to this type from the input type.

impl From<Time> for Value

fn from(v: Time) -> Value

Converts to this type from the input type.

impl<T> From<Vec<T>> for Value

where T: Into<Value>,

fn from(v: Vec<T>) -> Value

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Value

Converts to this type from the input type.

impl From<f32> for Value

fn from(v: f32) -> Value

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Value

Converts to this type from the input type.

impl From<i16> for Value

fn from(v: i16) -> Value

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Value

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Value

Converts to this type from the input type.

impl From<i8> for Value

fn from(v: i8) -> Value

Converts to this type from the input type.

impl From<u16> for Value

fn from(v: u16) -> Value

Converts to this type from the input type.

impl From<u32> for Value

fn from(v: u32) -> Value

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Value

Converts to this type from the input type.

impl From<u8> for Value

fn from(v: u8) -> Value

Converts to this type from the input type.

impl<K, T> FromIterator<(K, T)> for Value

where K: Into<String>, T: Into<Value>,

fn from_iter<I>(iter: I) -> Value

where I: IntoIterator<Item = (K, T)>,

Creates a value from an iterator.

impl<T> FromIterator<T> for Value

where T: Into<Value>,

fn from_iter<I>(iter: I) -> Value

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl PartialEq for Value

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

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

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 Serialize for Value

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Value> for Duration

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: Value, ) -> Result<Duration, <Duration as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for HashMap<String, Value>

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: Value, ) -> Result<HashMap<String, Value>, <HashMap<String, Value> as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for String

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<String, <String as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for Time

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Time, <Time as TryFrom<Value>>::Error>

Performs the conversion.

impl<T> TryFrom<Value> for Vec<T>

where T: TryFrom<Value>,

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Value> for u32

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<u32, <u32 as TryFrom<Value>>::Error>

Performs the conversion.

impl TryFrom<Value> for u64

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<u64, <u64 as TryFrom<Value>>::Error>

Performs the conversion.

impl StructuralPartialEq for Value