Struct RequestHeader

pub struct RequestHeader {
    pub bucket_id: Option<BucketId>,
    /* private fields */
}

The header of a request packet

Fields

• type_and_flags - the type of the packet and the flags
• bucket_id - the id of the bucket the packet is for (optional)

Fields

bucket_id: Option<BucketId>

Implementations

impl RequestHeader

pub fn new(packet_type: u8, bucket_id: Option<BucketId>) -> Self

Create new request header

Arguments

• packet_type - the type of the packet
• bucket_id - the id of the bucket the packet is for (optional)

pub fn has_bucket_id(&self) -> bool

Indicates if this packet type needs a bucket id

Trait Implementations

impl PtpHeader for RequestHeader

fn has_mac(&self) -> bool

Returns true if the packet has a MAC (according to the flags)

fn set_mac(&mut self, has_mac: bool)

Sets the MAC flag

fn packet_type(&self) -> u8

Returns the packet type

fn set_packet_type(&mut self, packet_type: u8)

Sets the packet type

fn flags(&self) -> (bool, bool, bool)

Returns the 3 extra flags which differ per packet type

fn set_flags(&mut self, flags: (bool, bool, bool))

Sets the 3 extra flags (which differ per packet type)

impl PtpHeaderBase for RequestHeader

fn get_type_and_flags(&self) -> u8

fn set_type_and_flags(&mut self, type_and_flags: u8)

impl PtpPacket<RequestHeader, RequestBody> for RequestPacket

fn get_header(&self) -> &RequestHeader

Returns the header of the packet

fn get_body(&self) -> &RequestBody

Returns the body of the packet

fn new(header: RequestHeader, body: RequestBody, mac: Option<[u8; 16]>) -> Self

Create a new packet with the given header, body and MAC

fn get_mac(&self) -> Option<&[u8; 16]>

Returns the MAC of the packet (if present)

fn from_bytes( data: &[u8], info: SerializationInfo, ) -> Result<Self, SerializationError>

where Self: Sized,

Deserialize packet from bytes

fn get_bytes( &self, info: SerializationInfo, with_len: bool, ) -> Result<Vec<u8>, SerializationError>

Serialize packet to bytes

fn verify_mac(&self, key: &[u8; 32], bucket_key: Option<[u8; 32]>) -> bool

Verifies the MAC of the packet This method is needed so a non-encrypted packet can be checked after deserialization if we do not want to “peek” the header, which is less efficient

impl Serializable for RequestHeader

fn size(&self) -> usize

Returns the size of the serialized data in bytes.

fn get_bytes(&self) -> Vec<u8>

Serializes the data into a vector of bytes.

fn from_bytes( data: &[u8], info: Option<SerializationInfo>, ) -> Result<Self, SerializationError>

where Self: Sized,

Deserializes the data from a vector of bytes.