Struct WriteOptions 

pub struct WriteOptions { /* private fields */ }

Type to be used with write_with_options. Use WriteOptionsBuilder to construct this.

Implementations

impl WriteOptions

pub fn related_sample_identity(&self) -> Option<SampleIdentity>

pub fn source_timestamp(&self) -> Option<Timestamp>

pub fn to_single_reader(&self) -> Option<GUID>

pub fn best_effort_may_block(&self) -> bool

Whether a best-effort write call is allowed to block under send-socket congestion (see WriteOptionsBuilder::best_effort_may_block).

Only meaningful for best-effort DataWriters; reliable writers always apply back-pressure regardless of this flag. Defaults to false, so by default a best-effort write never blocks and drops samples under congestion, as required by DDS v1.4 section 2.2.2.4.2.11.

Trait Implementations

impl Clone for WriteOptions

fn clone(&self) -> WriteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOptions

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

Formats the value using the given formatter.

impl Default for WriteOptions

fn default() -> WriteOptions

Returns the “default value” for a type.

impl Eq for WriteOptions

impl From<Option<Timestamp>> for WriteOptions

fn from(source_timestamp: Option<Timestamp>) -> Self

Converts to this type from the input type.

impl Ord for WriteOptions

fn cmp(&self, other: &WriteOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WriteOptions

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for WriteOptions

fn partial_cmp(&self, other: &WriteOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for WriteOptions