Struct IpcHandshake 

#[repr(C)]
pub struct IpcHandshake {
    pub magic: u32,
    pub protocol_version: u16,
    pub _reserved: u16,
    pub client_abi_major: u16,
    pub client_abi_minor: u16,
    pub nonce: u32,
    pub flags: u32,
}

First message a client sends after ipc_connect to negotiate protocol.

Wire size: 20 bytes.

Fields

• magic: must be IPC_HANDSHAKE_MAGIC (0x4950_4339)
• protocol_version: client’s IPC protocol version
• client_abi_major/minor: client’s ABI version
• nonce: random value for connection identification (optional)
• flags: reserved for future use (must be 0)

Fields

magic: u32

Magic number ("IPC9").

protocol_version: u16

IPC protocol version.

_reserved: u16

client_abi_major: u16

Client ABI major version.

client_abi_minor: u16

Client ABI minor version.

nonce: u32

Random nonce for connection identification.

flags: u32

Reserved flags (must be 0).

Implementations

impl IpcHandshake

pub const fn new() -> Self

Build a default handshake with a zero nonce.

pub const fn new_with_nonce(nonce: u32) -> Self

Build a handshake with a caller-provided nonce.

The nonce is used by the server to uniquely identify this connection.

pub fn is_valid(&self) -> bool

Return true when the message carries the expected handshake magic.

pub fn is_compatible(&self) -> bool

Return true when magic and protocol version match this ABI.

Trait Implementations

impl Clone for IpcHandshake

fn clone(&self) -> IpcHandshake

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IpcHandshake

impl Debug for IpcHandshake

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

Formats the value using the given formatter.

impl FromBytes for IpcHandshake

where u32: FromBytes, u16: FromBytes,

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

where Self: Sized,

Reads a copy of Self from the given source.

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.

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.

impl FromZeros for IpcHandshake

where u32: FromZeros, u16: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl IntoBytes for IpcHandshake

where u32: IntoBytes, u16: IntoBytes, (): PaddingFree<Self, { _ }>,

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

impl TryFromBytes for IpcHandshake

where u32: TryFromBytes, u16: 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.

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.

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.