Expand description
DoIP protocol encoding and decoding library
This crate provides all the Diagnostic over IP messages, with their associated :
- encoding into a writer
- decoding from a reader
For reference on the protocol, see ISO-14229-1.
A DoIP message is composed of a header and a payload, ie. DoIpHeader and Payload.
The payload is the meaningfull part of the message, and is one of the
message module structs.
A typical reception sequence using the library would be :
- call
read_header(). - call
read_payload()on the correct type. - see documentation of
read_message().
A typical emission sequence using the library would be :
- build a message struct which implements
Payload. - send it with
write_message(). - see documentation of
write_message().
Modules§
- message
- Module containing all the messages handled by the API.
Structs§
- DoIp
Header - Generic DoIP header data structure.
Enums§
- DoIp
Error - DoIp generic error return
- Payload
Type - Supported DoIP payload types.
Constants§
- DOIP_
HEADER_ LENGTH - Length of the DoIP header.
Traits§
- Borrowed
Payload - A DoIP payload with references
- Payload
- A DoIP payload
Functions§
- length_
message - Length of a DoIp message in bytes
- read_
header - Read a DoIp header
- read_
message - Reads a DoIP header and attemps to read a DoIp payload
- read_
payload - Read a specific DoIp payload, specifying the exact payload through Payload type
- read_
replace_ message - Read a specific DoIp message into an existing message
- read_
replace_ payload - Read a specific DoIp payload into an existing payload
- write_
message - Writes a DoIP header and its DoIp payload
Type Aliases§
- Logical
Address - A DoIP logical address, both for a tester or a tested entity
- Vin
- A Vehicle Identifier Number