Struct SomeIpHeader 

pub struct SomeIpHeader {
    pub service_id: ServiceId,
    pub method_id: MethodId,
    pub length: u32,
    pub client_id: ClientId,
    pub session_id: SessionId,
    pub protocol_version: u8,
    pub interface_version: u8,
    pub message_type: MessageType,
    pub return_code: ReturnCode,
}

SOME/IP message header (16 bytes).

+----------------+----------------+----------------+----------------+
|           Message ID (32 bits)                                   |
|   Service ID (16 bits)  |  Method ID (16 bits)                   |
+----------------+----------------+----------------+----------------+
|           Length (32 bits) - payload length + 8                  |
+----------------+----------------+----------------+----------------+
|           Request ID (32 bits)                                   |
|   Client ID (16 bits)   |  Session ID (16 bits)                  |
+----------------+----------------+----------------+----------------+
| Protocol Ver | Interface Ver | Message Type | Return Code        |
| (8 bits)     | (8 bits)      | (8 bits)     | (8 bits)           |
+----------------+----------------+----------------+----------------+

Fields

service_id: ServiceId

Service ID.

method_id: MethodId

Method ID.

length: u32

Length of payload + 8 bytes (client_id, session_id, protocol_version, interface_version, message_type, return_code).

client_id: ClientId

Client ID.

session_id: SessionId

Session ID.

protocol_version: u8

Protocol version (should be 0x01).

interface_version: u8

Interface version.

message_type: MessageType

Message type.

return_code: ReturnCode

Return code.

Implementations

impl SomeIpHeader

pub fn new(service_id: ServiceId, method_id: MethodId) -> Self

Create a new header with the given service and method IDs.

Examples found in repository

examples/message_basics.rs (line 59)

fn main() {
    println!("=== SOME/IP Message Basics ===\n");

    // Example 1: Create a request message using the builder
    println!("--- Example 1: Building Messages ---");
    let request = SomeIpMessage::request(ServiceId(0x1234), MethodId(0x0001))
        .client_id(ClientId(0x0100))
        .session_id(SessionId(0x0001))
        .interface_version(2)
        .payload(b"Hello, World!".as_slice())
        .build();

    println!("Request message:");
    print_message(&request);

    // Example 2: Create a response from the request
    println!("\n--- Example 2: Creating Responses ---");
    let response = request
        .create_response()
        .payload(b"Response data".as_slice())
        .build();

    println!("Response message:");
    print_message(&response);

    // Example 3: Create an error response
    println!("\n--- Example 3: Error Response ---");
    let error = request
        .create_error_response(ReturnCode::UnknownMethod)
        .build();

    println!("Error response:");
    print_message(&error);

    // Example 4: Serialize and deserialize
    println!("\n--- Example 4: Serialization ---");
    let bytes = request.to_bytes();
    println!("Serialized to {} bytes", bytes.len());
    println!("Header bytes: {:02X?}", &bytes[..HEADER_SIZE]);
    println!("Payload bytes: {:02X?}", &bytes[HEADER_SIZE..]);

    let parsed = SomeIpMessage::from_bytes(&bytes).expect("Failed to parse");
    println!("\nParsed message matches original: {}", parsed == request);

    // Example 5: Working with headers directly
    println!("\n--- Example 5: Header Details ---");
    let header = SomeIpHeader::new(ServiceId(0xFFFF), MethodId(0x8001));
    println!("Service ID: {}", header.service_id);
    println!("Method ID: {} (is_event: {})", header.method_id, header.method_id.is_event());
    println!("Message ID: 0x{:08X}", header.message_id());
    println!("Request ID: 0x{:08X}", header.request_id());

    // Example 6: Different message types
    println!("\n--- Example 6: Message Types ---");

    let notification = SomeIpMessage::notification(ServiceId(0x1234), MethodId::event(0x0001))
        .payload(b"Event data".as_slice())
        .build();
    println!("Notification: type={:?}, method_id={} (is_event: {})",
        notification.header.message_type,
        notification.header.method_id,
        notification.header.method_id.is_event()
    );

    let fire_and_forget = SomeIpMessage::request_no_return(ServiceId(0x1234), MethodId(0x0002))
        .payload(b"Fire and forget".as_slice())
        .build();
    println!("Fire-and-forget: type={:?}, expects_response: {}",
        fire_and_forget.header.message_type,
        fire_and_forget.expects_response()
    );

    // Example 7: Return codes
    println!("\n--- Example 7: Return Codes ---");
    for code in [
        ReturnCode::Ok,
        ReturnCode::NotOk,
        ReturnCode::UnknownService,
        ReturnCode::UnknownMethod,
        ReturnCode::Timeout,
    ] {
        println!("  {:?}: is_ok={}, value=0x{:02X}", code, code.is_ok(), code as u8);
    }

    println!("\n=== Done! ===");
}

pub fn request(service_id: ServiceId, method_id: MethodId) -> Self

Create a request header.

pub fn request_no_return(service_id: ServiceId, method_id: MethodId) -> Self

Create a request-no-return header.

pub fn notification(service_id: ServiceId, method_id: MethodId) -> Self

Create a notification header.

pub fn response_from(request: &Self) -> Self

Create a response header from a request header.

pub fn error_from(request: &Self, return_code: ReturnCode) -> Self

Create an error response header from a request header.

pub fn payload_length(&self) -> u32

Get the payload length (length field minus 8).

pub fn set_payload_length(&mut self, payload_len: u32)

Set the payload length (updates length field to payload_len + 8).

pub fn from_bytes(data: &[u8]) -> Result<Self>

Parse a header from bytes.

pub fn to_bytes(&self) -> [u8; 16]

Serialize the header to bytes.

pub fn message_id(&self) -> u32

Get the message ID (service_id << 16 | method_id).

Examples found in repository

examples/message_basics.rs (line 62)

fn main() {
    println!("=== SOME/IP Message Basics ===\n");

    // Example 1: Create a request message using the builder
    println!("--- Example 1: Building Messages ---");
    let request = SomeIpMessage::request(ServiceId(0x1234), MethodId(0x0001))
        .client_id(ClientId(0x0100))
        .session_id(SessionId(0x0001))
        .interface_version(2)
        .payload(b"Hello, World!".as_slice())
        .build();

    println!("Request message:");
    print_message(&request);

    // Example 2: Create a response from the request
    println!("\n--- Example 2: Creating Responses ---");
    let response = request
        .create_response()
        .payload(b"Response data".as_slice())
        .build();

    println!("Response message:");
    print_message(&response);

    // Example 3: Create an error response
    println!("\n--- Example 3: Error Response ---");
    let error = request
        .create_error_response(ReturnCode::UnknownMethod)
        .build();

    println!("Error response:");
    print_message(&error);

    // Example 4: Serialize and deserialize
    println!("\n--- Example 4: Serialization ---");
    let bytes = request.to_bytes();
    println!("Serialized to {} bytes", bytes.len());
    println!("Header bytes: {:02X?}", &bytes[..HEADER_SIZE]);
    println!("Payload bytes: {:02X?}", &bytes[HEADER_SIZE..]);

    let parsed = SomeIpMessage::from_bytes(&bytes).expect("Failed to parse");
    println!("\nParsed message matches original: {}", parsed == request);

    // Example 5: Working with headers directly
    println!("\n--- Example 5: Header Details ---");
    let header = SomeIpHeader::new(ServiceId(0xFFFF), MethodId(0x8001));
    println!("Service ID: {}", header.service_id);
    println!("Method ID: {} (is_event: {})", header.method_id, header.method_id.is_event());
    println!("Message ID: 0x{:08X}", header.message_id());
    println!("Request ID: 0x{:08X}", header.request_id());

    // Example 6: Different message types
    println!("\n--- Example 6: Message Types ---");

    let notification = SomeIpMessage::notification(ServiceId(0x1234), MethodId::event(0x0001))
        .payload(b"Event data".as_slice())
        .build();
    println!("Notification: type={:?}, method_id={} (is_event: {})",
        notification.header.message_type,
        notification.header.method_id,
        notification.header.method_id.is_event()
    );

    let fire_and_forget = SomeIpMessage::request_no_return(ServiceId(0x1234), MethodId(0x0002))
        .payload(b"Fire and forget".as_slice())
        .build();
    println!("Fire-and-forget: type={:?}, expects_response: {}",
        fire_and_forget.header.message_type,
        fire_and_forget.expects_response()
    );

    // Example 7: Return codes
    println!("\n--- Example 7: Return Codes ---");
    for code in [
        ReturnCode::Ok,
        ReturnCode::NotOk,
        ReturnCode::UnknownService,
        ReturnCode::UnknownMethod,
        ReturnCode::Timeout,
    ] {
        println!("  {:?}: is_ok={}, value=0x{:02X}", code, code.is_ok(), code as u8);
    }

    println!("\n=== Done! ===");
}

pub fn request_id(&self) -> u32

Get the request ID (client_id << 16 | session_id).

Examples found in repository

examples/message_basics.rs (line 63)

fn main() {
    println!("=== SOME/IP Message Basics ===\n");

    // Example 1: Create a request message using the builder
    println!("--- Example 1: Building Messages ---");
    let request = SomeIpMessage::request(ServiceId(0x1234), MethodId(0x0001))
        .client_id(ClientId(0x0100))
        .session_id(SessionId(0x0001))
        .interface_version(2)
        .payload(b"Hello, World!".as_slice())
        .build();

    println!("Request message:");
    print_message(&request);

    // Example 2: Create a response from the request
    println!("\n--- Example 2: Creating Responses ---");
    let response = request
        .create_response()
        .payload(b"Response data".as_slice())
        .build();

    println!("Response message:");
    print_message(&response);

    // Example 3: Create an error response
    println!("\n--- Example 3: Error Response ---");
    let error = request
        .create_error_response(ReturnCode::UnknownMethod)
        .build();

    println!("Error response:");
    print_message(&error);

    // Example 4: Serialize and deserialize
    println!("\n--- Example 4: Serialization ---");
    let bytes = request.to_bytes();
    println!("Serialized to {} bytes", bytes.len());
    println!("Header bytes: {:02X?}", &bytes[..HEADER_SIZE]);
    println!("Payload bytes: {:02X?}", &bytes[HEADER_SIZE..]);

    let parsed = SomeIpMessage::from_bytes(&bytes).expect("Failed to parse");
    println!("\nParsed message matches original: {}", parsed == request);

    // Example 5: Working with headers directly
    println!("\n--- Example 5: Header Details ---");
    let header = SomeIpHeader::new(ServiceId(0xFFFF), MethodId(0x8001));
    println!("Service ID: {}", header.service_id);
    println!("Method ID: {} (is_event: {})", header.method_id, header.method_id.is_event());
    println!("Message ID: 0x{:08X}", header.message_id());
    println!("Request ID: 0x{:08X}", header.request_id());

    // Example 6: Different message types
    println!("\n--- Example 6: Message Types ---");

    let notification = SomeIpMessage::notification(ServiceId(0x1234), MethodId::event(0x0001))
        .payload(b"Event data".as_slice())
        .build();
    println!("Notification: type={:?}, method_id={} (is_event: {})",
        notification.header.message_type,
        notification.header.method_id,
        notification.header.method_id.is_event()
    );

    let fire_and_forget = SomeIpMessage::request_no_return(ServiceId(0x1234), MethodId(0x0002))
        .payload(b"Fire and forget".as_slice())
        .build();
    println!("Fire-and-forget: type={:?}, expects_response: {}",
        fire_and_forget.header.message_type,
        fire_and_forget.expects_response()
    );

    // Example 7: Return codes
    println!("\n--- Example 7: Return Codes ---");
    for code in [
        ReturnCode::Ok,
        ReturnCode::NotOk,
        ReturnCode::UnknownService,
        ReturnCode::UnknownMethod,
        ReturnCode::Timeout,
    ] {
        println!("  {:?}: is_ok={}, value=0x{:02X}", code, code.is_ok(), code as u8);
    }

    println!("\n=== Done! ===");
}

Trait Implementations

impl Clone for SomeIpHeader

fn clone(&self) -> SomeIpHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SomeIpHeader

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

Formats the value using the given formatter.

impl Default for SomeIpHeader

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SomeIpHeader

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SomeIpHeader

impl StructuralPartialEq for SomeIpHeader