Struct gio::InputMessage

source ·
pub struct InputMessage<'m> { /* private fields */ }
Expand description

Structure used for scatter/gather data input when receiving multiple messages or packets in one go. You generally pass in an array of empty #GInputVectors and the operation will use all the buffers as if they were one buffer, and will set @bytes_received to the total number of bytes received across all #GInputVectors.

This structure closely mirrors struct mmsghdr and struct msghdr from the POSIX sockets API (see man 2 recvmmsg).

If @address is non-None then it is set to the source address the message was received from, and the caller must free it afterwards.

If @control_messages is non-None then it is set to an array of control messages received with the message (if any), and the caller must free it afterwards. @num_control_messages is set to the number of elements in this array, which may be zero.

Flags relevant to this message will be returned in @flags. For example, MSG_EOR or MSG_TRUNC.

Implementations§

source§

impl<'m> InputMessage<'m>

source

pub fn new( address: Option<&'m mut Option<SocketAddress>>, vectors: &'m mut [InputVector<'m>], control_messages: Option<&'m mut SocketControlMessages> ) -> Self

source

pub fn vectors(&mut self) -> &'m mut [InputVector<'m>]

source

pub const fn flags(&self) -> i32

source

pub const fn bytes_received(&self) -> usize

Trait Implementations§

source§

impl<'m> Debug for InputMessage<'m>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'m> RefUnwindSafe for InputMessage<'m>

§

impl<'m> !Send for InputMessage<'m>

§

impl<'m> !Sync for InputMessage<'m>

§

impl<'m> Unpin for InputMessage<'m>

§

impl<'m> !UnwindSafe for InputMessage<'m>

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.