Skip to main content

IpcMessage

Struct IpcMessage 

Source
#[repr(C, align(64))]
pub struct IpcMessage { pub sender: u64, pub msg_type: u32, pub flags: u32, pub payload: [u8; 240], }
Expand description

Fixed-size IPC message (256 bytes, 64-byte aligned).

Used by IPC ports, channels, and the transport layer. The header occupies 16 bytes; the payload is 240 bytes.

Fields§

§sender: u64

PID/TID of the sending process.

§msg_type: u32

Message type identifier (protocol-specific).

§flags: u32

Message flags (protocol-specific).

§payload: [u8; 240]

Payload data (up to 240 bytes).

Implementations§

Source§

impl IpcMessage

Source

pub const WIRE_SIZE: usize = IPC_MESSAGE_SIZE

Total wire size of the message (including header).

Source

pub const ALIGN: usize = IPC_MESSAGE_ALIGN

Alignment requirement.

Source

pub const PAYLOAD_CAPACITY: usize = IPC_PAYLOAD_CAPACITY

Maximum payload bytes.

Source

pub const OPEN_INLINE_CAPACITY: usize

Usable payload capacity for OPEN inline path (240 - 6 bytes overhead).

Usable payload capacity for UNLINK inline path (240 - 2 bytes overhead).

Source

pub const READ_INLINE_CAPACITY: usize

Usable payload capacity for READ inline path (240 - 8 bytes overhead).

Source

pub const WRITE_INLINE_CAPACITY: usize

Usable payload capacity for WRITE inline path (240 - 18 bytes overhead).

Source

pub const fn new(msg_type: u32) -> Self

Create an empty IPC message for msg_type.

Source

pub fn error_reply(sender: u64, status: i32) -> Self

Build a standard error reply carrying a status code in payload.

The msg_type is set to 0x80 (error reply marker). The payload contains the error code as a little-endian i32.

Trait Implementations§

Source§

impl Clone for IpcMessage

Source§

fn clone(&self) -> IpcMessage

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 IpcMessage

Source§

impl Debug for IpcMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromBytes for IpcMessage
where u64: FromBytes, u32: FromBytes, [u8; 240]: FromBytes,

§

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>
where Self: Sized,

Reads a copy of Self from the given source. Read more
§

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>
where Self: Sized,

Reads a copy of Self from the prefix of the given source. Read more
§

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>
where Self: Sized,

Reads a copy of Self from the suffix of the given source. Read more
Source§

impl FromZeros for IpcMessage
where u64: FromZeros, u32: FromZeros, [u8; 240]: FromZeros,

§

fn zero(&mut self)

Overwrites self with zeros. Read more
§

fn new_zeroed() -> Self
where Self: Sized,

Creates an instance of Self from zeroed bytes. Read more
Source§

impl IntoBytes for IpcMessage
where u64: IntoBytes, u32: IntoBytes, [u8; 240]: IntoBytes, (): PaddingFree<Self, { _ }>,

§

fn as_mut_bytes(&mut self) -> &mut [u8]
where Self: FromBytes,

Gets the bytes of this value mutably. Read more
Source§

impl TryFromBytes for IpcMessage
where u64: TryFromBytes, u32: TryFromBytes, [u8; 240]: TryFromBytes,

§

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
where Self: Sized,

Attempts to read the given source as a Self. Read more
§

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
where Self: Sized,

Attempts to read a Self from the prefix of the given source. Read more
§

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>
where Self: Sized,

Attempts to read a Self from the suffix of the given source. 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.