Skip to main content

Twist

Struct Twist 

Source
pub struct Twist {
    pub linear: Vector3,
    pub angular: Vector3,
}
Expand description

A body velocity command (geometry_msgs/msg/Twist): a linear and an angular Vector3.

This is the message a ROS 2 robot is driven by on cmd_vel, the natural target for the body twists the pamoja-kit chassis and navigation helpers produce.

§Examples

use pamoja_ros2::msg::{Twist, Vector3};

let cmd = Twist {
    linear: Vector3::new(0.5, 0.0, 0.0),
    angular: Vector3::new(0.0, 0.0, 0.2),
};
assert_eq!(Twist::from_cdr(&cmd.to_cdr()), Some(cmd));

Fields§

§linear: Vector3

The linear velocity, in metres per second.

§angular: Vector3

The angular velocity, in radians per second.

Implementations§

Source§

impl Twist

Source

pub fn to_cdr(&self) -> Vec<u8>

Encodes the twist as a CDR message.

§Returns

The CDR-encoded bytes, header included.

Source

pub fn from_cdr(data: &[u8]) -> Option<Self>

Decodes a twist from a CDR message.

§Arguments
  • data - the CDR-encoded bytes, header included.
§Returns

Some(twist), or None if the buffer is not a valid little-endian CDR twist.

Trait Implementations§

Source§

impl Clone for Twist

Source§

fn clone(&self) -> Twist

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Twist

Source§

impl Debug for Twist

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Twist

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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.
Source§

impl StructuralPartialEq for Twist

Auto Trait Implementations§

§

impl Freeze for Twist

§

impl RefUnwindSafe for Twist

§

impl Send for Twist

§

impl Sync for Twist

§

impl Unpin for Twist

§

impl UnsafeUnpin for Twist

§

impl UnwindSafe for Twist

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.