Skip to main content

Module prelude

Module prelude 

Source

Re-exports§

pub use crate::Component;
pub use crate::DeclarativeNode;
pub use crate::NodeContext;
pub use crate::NodeActionClient;
pub use crate::NodeActionServer;
pub use crate::NodeDeclError;
pub use crate::NodeOptions;
pub use crate::NodeParameter;
pub use crate::NodePublisher;
pub use crate::NodeResult;
pub use crate::NodeServiceClient;
pub use crate::NodeServiceServer;
pub use crate::NodeSubscription;
pub use crate::NodeTimer;
pub use crate::ParameterDefault;
pub use crate::node;
pub use crate::ExecutorConfigEnvExt;

Macros§

log_debug
Emit at crate::Severity::Debug.
log_error
Emit at crate::Severity::Error.
log_fatal
Emit at crate::Severity::Fatal.
log_info
Emit at crate::Severity::Info.
log_warn
Emit at crate::Severity::Warn.
nros_debug_throttle
Emit at crate::Severity::Debug, at most once per interval_ms at this call site.
nros_debug_throttle_at
Emit at crate::Severity::Debug, at most once per interval_ms at this call site, measured against the now_ns the CALLER supplies.
nros_error_throttle
Emit at crate::Severity::Error, at most once per interval_ms at this call site.
nros_error_throttle_at
Emit at crate::Severity::Error, at most once per interval_ms at this call site, measured against the now_ns the CALLER supplies.
nros_fatal_throttle
Emit at crate::Severity::Fatal, at most once per interval_ms at this call site.
nros_fatal_throttle_at
Emit at crate::Severity::Fatal, at most once per interval_ms at this call site, measured against the now_ns the CALLER supplies.
nros_info_throttle
Emit at crate::Severity::Info, at most once per interval_ms at this call site.
nros_info_throttle_at
Emit at crate::Severity::Info, at most once per interval_ms at this call site, measured against the now_ns the CALLER supplies.
nros_warn_throttle
Emit at crate::Severity::Warn, at most once per interval_ms at this call site.
nros_warn_throttle_at
Emit at crate::Severity::Warn, at most once per interval_ms at this call site, measured against the now_ns the CALLER supplies.

Structs§

Clock
A clock for querying time
Duration
ROS Duration representation
EmbeddedPublisher
Typed publisher handle.
EmbeddedServiceClient
Typed service client handle with internal buffers.
Executor
ExecutorConfig
Configuration for opening an embedded executor session.
FeedbackStream
A stream of feedback messages from an action server.
GoalId
Unique identifier for a goal
GoalInfo
Information about a goal
GoalStatusStamped
Goal status with associated goal info
GuardCondition
Handle for triggering a guard condition from outside the executor.
LifecyclePollingNode
Standalone lifecycle state machine for no_std environments.
Logger
A named logger with a runtime severity threshold.
MandatoryParameter
A parameter that must always have a value
MessageInfo
Metadata about a received message
Node
A ROS 2 node — rclrs’s Node, and the ONE node type (phase-483 W2).
OptionalParameter
A parameter that may or may not have a value
ParameterBuilder
Builder for declaring a typed parameter
ParameterServer
Parameter server over caller-owned storage
ParameterStorage
Backing storage a caller places, then lends to a ParameterServer.
Promise
A pending reply from a non-blocking service or action call.
PublisherOptions
Options for creating a publisher
QoSProfile
Full DDS-shaped QoS profile. Matches the field set of upstream rmw_qos_profile_t.
ReadOnlyParameter
A parameter whose value cannot be changed after declaration
SpinOnceResult
Result of a single spin iteration
SpinOptions
Options controlling a blocking spin loop — rclrs’s SpinOptions.
SpinPeriodPollingResult
Result from a single period of polling execution (no_std compatible).
SpinPeriodResult
Result from a single period with monotonic-clock measurement.
Subscription
Typed subscription handle with internal receive buffer.
SubscriptionOptions
Options for creating a subscriber
Time
ROS Time representation
TimerDuration
Duration type for timer periods
TimerHandle
A handle to a timer stored in a node
TopicInfo
Topic information for pub/sub

Enums§

ClockType
Type of clock to use for time queries
GoalResponse
Goal accept/reject response codes
GoalStatus
Goal status states
LifecycleError
Error type for lifecycle transitions.
LifecycleState
Lifecycle state (REP-2002)
LifecycleTransition
Lifecycle transition (REP-2002)
NodeError
Error type for generic embedded node operations.
ParameterError
Error type for typed parameter operations
ParameterType
ROS 2 parameter types
ParameterValue
Parameter value container
QoSDurabilityPolicy
QoS durability policy
QoSHistoryPolicy
QoS history policy
QoSReliabilityPolicy
QoS reliability policy
SessionMode
Session mode
TimerMode
Timer mode (repeating, one-shot, or inert)
TransitionResult
Result of a lifecycle transition callback.
TransportError
Transport error types.
Trigger
Executor-level trigger condition.

Traits§

Deserialize
Trait for types that can be deserialized from CDR format
ParameterVariant
Trait for types that can be used as typed parameters
RosAction
Trait for ROS 2 action types
RosMessage
Trait for ROS message types
RosService
Trait for ROS service types
Serialize
Trait for types that can be serialized to CDR format

Type Aliases§

LifecycleCallbackFn
Lifecycle callback function pointer (no_std compatible).
TimerCallbackFn
Timer callback as a bare function pointer (no_std, no heap required).