Skip to main content

rmw_publisher_t

Struct rmw_publisher_t 

Source
#[repr(C)]
pub struct rmw_publisher_t { pub topic_name: *const c_char, pub type_name: *const c_char, pub qos: rmw_qos_profile_t, pub can_loan_messages: bool, pub _reserved: [u8; 7], pub backend_data: *mut c_void, }
Expand description

Publisher entity.

Created by vtable->create_publisher; destroyed by vtable->destroy_publisher. The runtime owns the storage; the runtime fills topic_name / type_name / qos before the create call. The backend writes backend_data.

can_loan_messages matches upstream rmw_publisher_t’s field of the same name — true means the backend exposes the loan_publish / commit_publish primitive (Phase 99).

The runtime DERIVES it; a backend does not write it (issue 0814). Its value is exactly vtable->borrow_loaned_message != NULL, because that is the same fact, and a fact with two spellings drifts — this one had drifted in both directions at once. Anything a backend writes here is overwritten.

This paragraph used to read “the runtime reads it once at create time and picks the publish path accordingly; no per-call probe”. That was never true: nothing has ever branched on the field, and the publish path is chosen per call from vtable->borrow_loaned_message itself.

To refuse a loan for a PARTICULAR entity, return RMW_RET_UNSUPPORTED from borrow_loaned_message. The per-entity answer belongs on the call, which the runtime consults; not on this flag, which it does not.

Fields§

§topic_name: *const c_char

Topic name (borrowed; outlives the publisher).

§type_name: *const c_char

ROS-2-style fully-qualified type name (e.g., "std_msgs/msg/Int32"). Borrowed; outlives the publisher.

§qos: rmw_qos_profile_t

QoS subset honoured by this publisher.

§can_loan_messages: bool

Backend exposes loan_publish / commit_publish (Phase 99). DERIVED by the runtime from vtable->borrow_loaned_message; a backend’s write is overwritten (issue 0814).

§_reserved: [u8; 7]

Reserved for future fields; must be zero.

§backend_data: *mut c_void

Opaque backend state. NULL if creation failed.

Trait Implementations§

Source§

impl Clone for rmw_publisher_t

Source§

fn clone(&self) -> rmw_publisher_t

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for rmw_publisher_t

Source§

impl Debug for rmw_publisher_t

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.