pub struct PrimitiveOptions<'a> {
pub name: &'a str,
pub history: Option<QoSHistoryPolicy>,
pub depth: Option<u32>,
pub reliability: Option<QoSReliabilityPolicy>,
pub durability: Option<QoSDurabilityPolicy>,
pub deadline_ms: Option<u32>,
pub lifespan_ms: Option<u32>,
pub liveliness: Option<QoSLivelinessPolicy>,
pub liveliness_lease_ms: Option<u32>,
pub avoid_ros_namespace_conventions: Option<bool>,
}Expand description
phase-515 R1 – rclrs’s per-entity options and IntoPrimitiveOptions.
rclrs’s PrimitiveOptions: an entity’s name plus the QoS policies its
create site stated.
ADOPT-BOUNDED against rclrs: the duration-valued policies hold whole
milliseconds (the unit QoSProfile records, 0 = infinite) where rclrs
holds a QoSDuration enum, so deadline / lifespan / liveliness_lease
take a core::time::Duration and the infinite case is
no_deadline /
infinite_lifespan. History and
depth are two fields because QoSProfile keeps them apart.
Fields§
§name: &'a strThe entity’s (source) name: topic or service.
history: Option<QoSHistoryPolicy>History policy, if stated.
depth: Option<u32>Queue depth, if stated (keep_last(n) states both).
reliability: Option<QoSReliabilityPolicy>Reliability policy, if stated.
durability: Option<QoSDurabilityPolicy>Durability policy, if stated.
deadline_ms: Option<u32>Deadline in milliseconds (0 = none), if stated.
lifespan_ms: Option<u32>Lifespan in milliseconds (0 = infinite), if stated.
liveliness: Option<QoSLivelinessPolicy>Liveliness policy, if stated.
liveliness_lease_ms: Option<u32>Liveliness lease in milliseconds (0 = infinite), if stated.
avoid_ros_namespace_conventions: Option<bool>Skip the ROS topic-name prefix, if stated.
Implementations§
Source§impl<'a> PrimitiveOptions<'a>
impl<'a> PrimitiveOptions<'a>
Sourcepub fn apply_to(&self, qos: &mut QoSProfile)
pub fn apply_to(&self, qos: &mut QoSProfile)
rclrs’s apply_to: overwrite each policy this value states, leave the
rest of qos as it is.
Sourcepub fn resolve(&self, default: QoSProfile) -> QoSProfile
pub fn resolve(&self, default: QoSProfile) -> QoSProfile
default with this value’s stated policies applied — what a create
site resolves.
Trait Implementations§
Source§impl<'a> Clone for PrimitiveOptions<'a>
impl<'a> Clone for PrimitiveOptions<'a>
Source§fn clone(&self) -> PrimitiveOptions<'a>
fn clone(&self) -> PrimitiveOptions<'a>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl<'a> Copy for PrimitiveOptions<'a>
Source§impl<'a> Debug for PrimitiveOptions<'a>
impl<'a> Debug for PrimitiveOptions<'a>
impl<'a> Eq for PrimitiveOptions<'a>
Source§impl<'a> IntoPrimitiveOptions<'a> for PrimitiveOptions<'a>
impl<'a> IntoPrimitiveOptions<'a> for PrimitiveOptions<'a>
Source§fn into_primitive_options(self) -> PrimitiveOptions<'a>
fn into_primitive_options(self) -> PrimitiveOptions<'a>
Source§fn qos(self, profile: QoSProfile) -> PrimitiveOptions<'a>
fn qos(self, profile: QoSProfile) -> PrimitiveOptions<'a>
profile.Source§fn topics_qos(self) -> PrimitiveOptions<'a>
fn topics_qos(self) -> PrimitiveOptions<'a>
Source§fn sensor_data_qos(self) -> PrimitiveOptions<'a>
fn sensor_data_qos(self) -> PrimitiveOptions<'a>
Source§fn services_qos(self) -> PrimitiveOptions<'a>
fn services_qos(self) -> PrimitiveOptions<'a>
Source§fn system_qos(self) -> PrimitiveOptions<'a>
fn system_qos(self) -> PrimitiveOptions<'a>
Source§fn history(self, history: QoSHistoryPolicy) -> PrimitiveOptions<'a>
fn history(self, history: QoSHistoryPolicy) -> PrimitiveOptions<'a>
Source§fn keep_last(self, depth: u32) -> PrimitiveOptions<'a>
fn keep_last(self, depth: u32) -> PrimitiveOptions<'a>
depth samples.Source§fn keep_all(self) -> PrimitiveOptions<'a>
fn keep_all(self) -> PrimitiveOptions<'a>
Source§fn reliability(self, reliability: QoSReliabilityPolicy) -> PrimitiveOptions<'a>
fn reliability(self, reliability: QoSReliabilityPolicy) -> PrimitiveOptions<'a>
Source§fn reliable(self) -> PrimitiveOptions<'a>
fn reliable(self) -> PrimitiveOptions<'a>
Source§fn best_effort(self) -> PrimitiveOptions<'a>
fn best_effort(self) -> PrimitiveOptions<'a>
Source§fn durability(self, durability: QoSDurabilityPolicy) -> PrimitiveOptions<'a>
fn durability(self, durability: QoSDurabilityPolicy) -> PrimitiveOptions<'a>
Source§fn volatile(self) -> PrimitiveOptions<'a>
fn volatile(self) -> PrimitiveOptions<'a>
Source§fn transient_local(self) -> PrimitiveOptions<'a>
fn transient_local(self) -> PrimitiveOptions<'a>
Source§fn lifespan(self, lifespan: Duration) -> PrimitiveOptions<'a>
fn lifespan(self, lifespan: Duration) -> PrimitiveOptions<'a>
Duration, not rclrs’s QoSDuration.Source§fn lifespan_duration(self, duration: Duration) -> PrimitiveOptions<'a>
fn lifespan_duration(self, duration: Duration) -> PrimitiveOptions<'a>
lifespan_duration, the same as lifespan.Source§fn infinite_lifespan(self) -> PrimitiveOptions<'a>
fn infinite_lifespan(self) -> PrimitiveOptions<'a>
Source§fn deadline(self, deadline: Duration) -> PrimitiveOptions<'a>
fn deadline(self, deadline: Duration) -> PrimitiveOptions<'a>
Duration, not rclrs’s QoSDuration.Source§fn deadline_duration(self, duration: Duration) -> PrimitiveOptions<'a>
fn deadline_duration(self, duration: Duration) -> PrimitiveOptions<'a>
deadline_duration, the same as deadline.Source§fn no_deadline(self) -> PrimitiveOptions<'a>
fn no_deadline(self) -> PrimitiveOptions<'a>
Source§fn liveliness(self, liveliness: QoSLivelinessPolicy) -> PrimitiveOptions<'a>
fn liveliness(self, liveliness: QoSLivelinessPolicy) -> PrimitiveOptions<'a>
Source§fn liveliness_automatic(self) -> PrimitiveOptions<'a>
fn liveliness_automatic(self) -> PrimitiveOptions<'a>
Source§fn liveliness_manual(self) -> PrimitiveOptions<'a>
fn liveliness_manual(self) -> PrimitiveOptions<'a>
Source§fn liveliness_lease(self, lease: Duration) -> PrimitiveOptions<'a>
fn liveliness_lease(self, lease: Duration) -> PrimitiveOptions<'a>
Duration, not rclrs’s
QoSDuration.Source§fn liveliness_lease_duration(self, duration: Duration) -> PrimitiveOptions<'a>
fn liveliness_lease_duration(self, duration: Duration) -> PrimitiveOptions<'a>
liveliness_lease_duration, the same as
liveliness_lease.