Crate rclrs

source ·
Expand description

Rust client library for ROS 2.

For getting started, see the README.

Structs

  • This struct is given to the discriminator function of the ParameterBuilder so it knows what values are available to choose from.
  • Main class responsible for sending requests to a ROS service.
  • Internal struct used by clients.
  • Struct that implements a Clock and wraps rcl_clock_t.
  • A clock source that can be used to drive the contained clock. Created when a clock of type ClockType::RosTime is constructed
  • Shared state between nodes and similar entities.
  • A waitable entity used for waking up a wait set manually.
  • A message that is owned by the middleware, loaned for publishing.
  • A parameter that must have a value This struct has ownership of the declared parameter. Additional parameter declaration will fail while this struct exists and the parameter will be undeclared when it is dropped.
  • Additional information about a received message.
  • A processing unit that can communicate with other nodes.
  • A builder for creating a Node.
  • Stores a node’s name and namespace
  • A parameter that might not have a value, represented by Option<T>. This struct has ownership of the declared parameter. Additional parameter declaration will fail while this struct exists and the parameter will be undeclared when it is dropped.
  • Builder used to declare a parameter. Obtain this by calling crate::Node::declare_parameter.
  • Options that can be attached to a parameter, such as description, ranges. Some of this data will be used to populate the ParameterDescriptor
  • Describes the range for paramter type T.
  • Contains all the possible type of ranges that can be applied to a value. Usually only one of these ranges will be applied, but all have to be stored since:
  • Allows access to all parameters via get / set functions, using their name as a key.
  • Struct for sending messages of type T.
  • An identifier for a publisher in the local context.
  • A Quality of Service profile.
  • Struct encapsulating an error message from the rcl layer or below.
  • A message that is owned by the middleware, loaned out for reading.
  • A parameter that must have a value and cannot be written to This struct has ownership of the declared parameter. Additional parameter declaration will fail while this struct exists and the parameter will be undeclared when it is dropped.
  • A list of entities that are ready, returned by WaitSet::wait.
  • Main class responsible for responding to requests sent by ROS clients.
  • Internal struct used by services.
  • Single-threaded executor implementation.
  • Struct for receiving messages of type T.
  • Internal struct used by subscriptions.
  • Struct that represents time.
  • Contains topic endpoint information
  • A struct for waiting on subscriptions and other waitable entities to become ready.

Enums

Constants

Traits

Functions

Type Aliases