Struct ros2_client::ros2::QosPolicies
source · pub struct QosPolicies { /* private fields */ }
Expand description
Describes a set of RTPS/DDS QoS policies
QosPolicies are constructed using a QosPolicyBuilder
Implementations§
source§impl QosPolicies
impl QosPolicies
pub fn qos_none() -> QosPolicies
pub fn builder() -> QosPolicyBuilder
pub const fn durability(&self) -> Option<Durability>
pub fn is_volatile(&self) -> bool
pub const fn presentation(&self) -> Option<Presentation>
pub const fn deadline(&self) -> Option<Deadline>
pub const fn latency_budget(&self) -> Option<LatencyBudget>
pub const fn ownership(&self) -> Option<Ownership>
pub const fn liveliness(&self) -> Option<Liveliness>
pub const fn time_based_filter(&self) -> Option<TimeBasedFilter>
pub const fn reliability(&self) -> Option<Reliability>
pub fn is_reliable(&self) -> bool
pub const fn reliable_max_blocking_time(&self) -> Option<Duration>
pub const fn destination_order(&self) -> Option<DestinationOrder>
pub const fn history(&self) -> Option<History>
pub const fn resource_limits(&self) -> Option<ResourceLimits>
pub const fn lifespan(&self) -> Option<Lifespan>
sourcepub fn modify_by(&self, other: &QosPolicies) -> QosPolicies
pub fn modify_by(&self, other: &QosPolicies) -> QosPolicies
Merge two QosPolicies
Constructs a QosPolicy, where each policy is taken from self
,
and overwritten with those policies from other
that are defined.
sourcepub fn compliance_failure_wrt(&self, other: &QosPolicies) -> Option<QosPolicyId>
pub fn compliance_failure_wrt(&self, other: &QosPolicies) -> Option<QosPolicyId>
Check if policy complies to another policy.
self
is the “offered” (publisher) QoS
other
is the “requested” (subscriber) QoS
- None => Policies are compatible
- Some(policyId) => Failure, where policyId is (any) one of the policies causing incompliance
Compliance (compatibility) is defined in the table in DDS spec v1.4 Section “2.2.3 Supported QoS”
This is not symmetric.
pub fn to_parameter_list( &self, ctx: Endianness, ) -> Result<Vec<Parameter>, PlCdrSerializeError>
pub fn from_parameter_list( ctx: Endianness, pl_map: &BTreeMap<ParameterId, Vec<&Parameter>>, ) -> Result<QosPolicies, PlCdrDeserializeError>
Trait Implementations§
source§impl Clone for QosPolicies
impl Clone for QosPolicies
source§fn clone(&self) -> QosPolicies
fn clone(&self) -> QosPolicies
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for QosPolicies
impl Debug for QosPolicies
source§impl Default for QosPolicies
impl Default for QosPolicies
source§fn default() -> QosPolicies
fn default() -> QosPolicies
Returns the “default value” for a type. Read more
source§impl<'de> Deserialize<'de> for QosPolicies
impl<'de> Deserialize<'de> for QosPolicies
source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<QosPolicies, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<QosPolicies, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl PartialEq for QosPolicies
impl PartialEq for QosPolicies
source§impl Serialize for QosPolicies
impl Serialize for QosPolicies
source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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. Read more
impl Eq for QosPolicies
impl StructuralPartialEq for QosPolicies
Auto Trait Implementations§
impl Freeze for QosPolicies
impl RefUnwindSafe for QosPolicies
impl Send for QosPolicies
impl Sync for QosPolicies
impl Unpin for QosPolicies
impl UnwindSafe for QosPolicies
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)