Skip to main content

rmw_mut_byte_span_t

Struct rmw_mut_byte_span_t 

Source
#[repr(C)]
pub struct rmw_mut_byte_span_t { pub data: *mut u8, pub capacity: usize, pub len: usize, }
Expand description

Room to WRITE — phase-406 W2.

This is upstream’s rmw_serialized_message_t MINUS THE ALLOCATOR. That is not a coincidence and it is the whole argument: upstream’s is an rcutils_uint8_array_t, {buffer, buffer_length, buffer_capacity, allocator}, and this ABI declined it because of the last field. Drop that field and the remaining three are exactly what a caller-owned destination needs, so the “carries an allocator” objection does not transfer to this.

capacity is a LIMIT (in) and len is a RESULT (out). They are separate fields rather than one overloaded len because “capacity on the way in, length on the way out” is the snprintf ambiguity, and it is a bug generator.

PASSED BY POINTER, always. The callee must set len, and a by-value copy would discard it — code that compiles, runs, and yields zero-length messages.

Fields§

§data: *mut u8§capacity: usize

In: bytes available at data.

§len: usize

Out: bytes actually written. Undefined on failure.

Trait Implementations§

Source§

impl Clone for rmw_mut_byte_span_t

Source§

fn clone(&self) -> rmw_mut_byte_span_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_mut_byte_span_t

Source§

impl Debug for rmw_mut_byte_span_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.