Skip to main content

MessageHeader

Struct MessageHeader 

Source
pub struct MessageHeader {
    pub version: Version,
    pub flags: Flags,
    pub message_type: MessageType,
    pub message_size: u32,
}
Expand description

GIOP message header (spec §15.4.1).

Fields§

§version: Version

GIOP version (spec §15.4.1).

§flags: Flags

Flags octet (in GIOP 1.0 only byte_order).

§message_type: MessageType

Message-type discriminant.

§message_size: u32

message_size — body size in bytes (excluding the header).

Implementations§

Source§

impl MessageHeader

Source

pub const fn new( version: Version, flags: Flags, message_type: MessageType, message_size: u32, ) -> Self

Constructor.

Source

pub const fn endianness(&self) -> Endianness

Returns the endianness from the flags octet (bit 0).

Source

pub fn encode(&self, w: &mut BufferWriter) -> GiopResult<()>

Encodes the 12-byte header.

§Errors

Buffer write error from the CDR layer.

Source

pub fn decode(bytes: &[u8]) -> GiopResult<(Self, &[u8])>

Decodes the 12-byte header.

Important: the caller must create the BufferReader with Endianness::Big — the first 8 bytes (magic+version+flags+msg_type) are endian-free, but the message_size u32 must be re-interpreted based on the flags byte. This helper reads the flags byte and flips the endianness if necessary.

§Errors
  • InvalidMagic if bytes 0..4 are not "GIOP".
  • UnsupportedVersion if major/minor is none of 1.0/1.1/1.2.
  • UnknownMessageType if the octet is not in 0..=7.
  • Buffer read error.

Trait Implementations§

Source§

impl Clone for MessageHeader

Source§

fn clone(&self) -> MessageHeader

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 MessageHeader

Source§

impl Debug for MessageHeader

Source§

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

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

impl Eq for MessageHeader

Source§

impl PartialEq for MessageHeader

Source§

fn eq(&self, other: &MessageHeader) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for MessageHeader

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.