Skip to main content

Crate cyclonedds

Crate cyclonedds 

Source

Re-exports§

pub use sample::Loan;
pub use sample::Sample;
pub use security::SecurityConfig;

Modules§

async
log
DDS Logging API – configurable log and trace sinks.
no_std_types
Safe, idiomatic Rust bindings for Eclipse CycloneDDS. Core DDS types for no_std environments.
observability
Observability helpers for tracing, OpenTelemetry, and tokio-console.
sample
security
DDS Security configuration helpers.

Structs§

BuiltinEndpointSample
BuiltinParticipantSample
BuiltinTopicSample
CdrDeserializer
Deserializer that reads a DdsType sample from CDR bytes.
CdrSample
A raw CDR sample obtained from a DataReader via read_cdr / take_cdr.
CdrSerializer
Serializer that writes a DdsType sample into a CDR byte stream.
ContentFilteredTopic
A content-filtered topic wraps a Topic with a writer-side filter closure. Only samples for which the closure returns true are written to the network.
DataReader
A typed DDS DataReader that receives samples of type T.
DataWriter
A typed DDS DataWriter that publishes samples of type T.
DdsBoundedSequence
DdsSequence
DdsString
DiscoveredParticipant
Information about a discovered participant.
DiscoveredTopic
Information about a discovered topic.
DiscoveredType
The result of a type discovery operation.
DomainParticipant
A DDS DomainParticipant is the entry-point for DDS communication.
DurabilityServicePolicy
DynamicBitmaskFieldSchema
DynamicData
A runtime-typed data value that can be read from and written to DDS.
DynamicEnumLiteralSchema
DynamicFieldSchema
DynamicMemberBuilder
DynamicType
DynamicTypeBuilder
DynamicUnionCaseSchema
EntityStatus
Consolidated status snapshot for any DDS entity.
FilterParams
Shared parameter store for content filters.
GuardCondition
InconsistentTopicStatus
Status for an inconsistent topic.
KeyDescriptor
Describes a key field for a keyed topic. ops_index is the index into the ops array path that contributes to this key. For flat keys, ops_path has one entry. For nested keys, it contains the parent field ADR index followed by the nested key path indices.
Listener
ListenerBuilder
LivelinessChangedStatus
Status for liveliness changes detected by a DataReader.
LivelinessLostStatus
Status for liveliness lost by a DataWriter.
MatchedEndpoint
MemberDescriptor
Description of a single type member (struct field, union case, enum literal).
OfferedDeadlineMissedStatus
Status for an offered deadline missed by a DataWriter.
OfferedIncompatibleQosStatus
Status for an offered incompatible QoS by a DataWriter.
OwnedSertype
OwnedTypeId
ParticipantPool
A pool of DDS domain participants with service discovery and health checks.
PresentationPolicy
PublicationMatchedStatus
Status for publication matched (writer found a compatible reader).
Publisher
Qos
QosBuilder
QosProvider
QueryCondition
ReadCondition
ReaderDataLifecyclePolicy
Replier
A DDS Replier that receives requests and sends replies.
RequestedDeadlineMissedStatus
Status for a requested deadline missed by a DataReader.
RequestedIncompatibleQosStatus
Status for a requested incompatible QoS by a DataReader.
Requester
A DDS Requester that sends requests and waits for matching replies.
SampleLostStatus
Status for samples lost by a DataReader.
SampleRejectedStatus
Status for samples rejected by a DataReader.
SerdeSample
A DDS sample that wraps any serde-compatible type.
SertypeHandle
StatisticEntryRef
Statistics
Subscriber
SubscriptionMatchedStatus
Status for subscription matched (reader found a compatible writer).
Topic
TopicDescriptor
TopicKeyDescriptor
TypeConsistencyPolicy
TypeDescriptor
High-level navigable type descriptor parsed from a TopicDescriptor’s ops.
TypeIdRef
TypeInfo
TypeObject
UntypedTopic
A topic without compile-time type information.
WaitSet
WriteLoan
A loaned sample buffer for zero-copy writing.

Enums§

CdrEncoding
CDR encoding version.
DataRepresentation
DdsError
DestinationOrder
DiscriminantType
Durability
DynamicEnumLiteralValue
DynamicPrimitiveKind
DynamicTypeAutoId
DynamicTypeExtensibility
DynamicTypeSchema
DynamicTypeSpec
DynamicValue
FindScope
History
IgnoreLocalKind
Liveliness
Ownership
PresentationAccessScope
QosKind
Reliability
SampleRejectedReason
Reason a sample was rejected by a DataReader.
StatisticKind
StatisticValue
TypeConsistency
TypeExtensibility
Extensibility of a DDS type.
TypeIdKind
TypeIncludeDeps
TypeKind
Kind of a DDS type (matches XTypes TypeKind).

Constants§

BUILTIN_TOPIC_DCPSPARTICIPANT
BUILTIN_TOPIC_DCPSPUBLICATION
BUILTIN_TOPIC_DCPSSUBSCRIPTION
BUILTIN_TOPIC_DCPSTOPIC
DDS_MIN_PSEUDO_HANDLE
DDS_OP_MASK_CONST
DDS_OP_SUBTYPE_MASK_CONST
DDS_OP_TYPE_MASK_CONST
OP_ADR
OP_DLC
OP_FLAG_EXT
OP_FLAG_FP
OP_FLAG_KEY
ADR flags (low 8 bits of the ADR opcode)
OP_FLAG_MU
OP_FLAG_OPT
OP_FLAG_SGN
OP_FLAG_SZ_SHIFT
OP_JEQ4
OP_KOF
Key Offset Format opcode. Format: [KOF | n, adr_ops_index_0, ..., adr_ops_index_(n-1)] where n = number of ADR opcode indices that contribute to this key path. For a flat key field (single member), n=1: [KOF | 1, adr_index]. KOF entries are placed AFTER OP_RTS in the ops array.
OP_MID
OP_RTS
STATUS_ALL
Convenience constant combining all status bits.
STATUS_DATA_AVAILABLE
Data available status bit (reader).
STATUS_DATA_ON_READERS
Data on readers status bit (subscriber).
STATUS_INCONSISTENT_TOPIC
Inconsistent topic status bit.
STATUS_LIVELINESS_CHANGED
Liveliness changed status bit (reader).
STATUS_LIVELINESS_LOST
Liveliness lost status bit (writer).
STATUS_OFFERED_DEADLINE_MISSED
Offered deadline missed status bit (writer).
STATUS_OFFERED_INCOMPATIBLE_QOS
Offered incompatible QoS status bit (writer).
STATUS_PUBLICATION_MATCHED
Publication matched status bit (writer).
STATUS_REQUESTED_DEADLINE_MISSED
Requested deadline missed status bit (reader).
STATUS_REQUESTED_INCOMPATIBLE_QOS
Requested incompatible QoS status bit (reader).
STATUS_SAMPLE_LOST
Sample lost status bit (reader).
STATUS_SAMPLE_REJECTED
Sample rejected status bit (reader).
STATUS_SUBSCRIPTION_MATCHED
Subscription matched status bit (reader).
SUBTYPE_1BY
SUBTYPE_2BY
SUBTYPE_4BY
SUBTYPE_8BY
SUBTYPE_BSQ
SUBTYPE_BST
SUBTYPE_ENU
SUBTYPE_SEQ
SUBTYPE_STR
SUBTYPE_STU
TYPE_1BY
TYPE_2BY
TYPE_4BY
TYPE_8BY
TYPE_ARR
TYPE_BSQ
TYPE_BST
TYPE_ENU
TYPE_EXT
TYPE_SEQ
TYPE_STR
TYPE_UNI

Traits§

DdsEntity
DdsEnumType
DdsSequenceElement
DdsType
DdsUnionType
RequestReply
Trait that types must implement to be used with Request-Reply pattern.
StatusExt
Extension trait that adds typed status-getter methods to any entity implementing DdsEntity.
TopicFilterExt
Extension trait that adds writer-side filter support to Topic<T>.
TopicParameterizedFilterExt
Extension trait for creating parameterized content filters on Topic.

Functions§

adr
adr_bst
adr_key
cdr_to_dynamic_data
Deserialize CDR bytes into a DynamicData value using the given schema and topic descriptor.
discover_all_publication_types
Get the type info from a matched publication and resolve it.
discover_all_subscription_types
Get the type info from a matched subscription and resolve it.
discover_type_from_endpoint
Discover a type from any matched endpoint.
discover_type_from_publication
Discover the type of a matched publication endpoint.
discover_type_from_subscription
Discover the type of a matched subscription endpoint.
discover_type_from_type_info
Discover a type directly from a TypeInfo obtained from any entity.
dynamic_data_to_cdr
Serialize a DynamicData value to CDR bytes using the topic descriptor obtained from a dynamic type registration.
err_file_id
err_line
err_nr
rebase_ops
set_active_qc
Set the active QueryCondition entity for the current thread.

Type Aliases§

DdsResult

Derive Macros§

DdsBitmaskDerive
DdsEnumDerive
DdsTypeDerive
DdsUnionDerive