Struct libpacket::ipv4::MutableIpv4Packet [−][src]
pub struct MutableIpv4Packet<'p> { /* fields omitted */ }
Expand description
A structure enabling manipulation of on the wire packets
Implementations
impl<'a> MutableIpv4Packet<'a>
[src]
impl<'a> MutableIpv4Packet<'a>
[src]pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableIpv4Packet<'p>>
[src]
pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableIpv4Packet<'p>>
[src]Constructs a new #name. If the provided buffer is less than the minimum required packet size, this will return None.
pub fn owned(packet: Vec<u8>) -> Option<MutableIpv4Packet<'static>>
[src]
pub fn owned(packet: Vec<u8>) -> Option<MutableIpv4Packet<'static>>
[src]Constructs a new #name. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the #name will own its own data and the underlying buffer will be dropped when the #name is.
pub fn to_immutable<'p>(&'p self) -> Ipv4Packet<'p>
[src]
pub fn to_immutable<'p>(&'p self) -> Ipv4Packet<'p>
[src]Maps from a #name to a #imm_name
pub fn consume_to_immutable(self) -> Ipv4Packet<'a>
[src]
pub fn consume_to_immutable(self) -> Ipv4Packet<'a>
[src]Maps from a #name to a #imm_name while consuming the source
pub const fn minimum_packet_size() -> usize
[src]
pub const fn minimum_packet_size() -> usize
[src]The minimum size (in bytes) a packet of this type can be. It’s based on the total size of the fixed-size fields.
pub fn packet_size(_packet: &Ipv4) -> usize
[src]
pub fn packet_size(_packet: &Ipv4) -> usize
[src]The size (in bytes) of a #base_name instance when converted into a byte-array
pub fn get_version(&self) -> u4
[src]
pub fn get_version(&self) -> u4
[src]Get the version field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_header_length(&self) -> u4
[src]
pub fn get_header_length(&self) -> u4
[src]Get the header_length field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_dscp(&self) -> u6
[src]
pub fn get_dscp(&self) -> u6
[src]Get the dscp field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_ecn(&self) -> u2
[src]
pub fn get_ecn(&self) -> u2
[src]Get the ecn field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_total_length(&self) -> u16be
[src]
pub fn get_total_length(&self) -> u16be
[src]Get the total_length field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_identification(&self) -> u16be
[src]
pub fn get_identification(&self) -> u16be
[src]Get the identification field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_flags(&self) -> u3
[src]
pub fn get_flags(&self) -> u3
[src]Get the flags field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_fragment_offset(&self) -> u13be
[src]
pub fn get_fragment_offset(&self) -> u13be
[src]Get the fragment_offset field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_ttl(&self) -> u8
[src]
pub fn get_ttl(&self) -> u8
[src]Get the ttl field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_next_level_protocol(&self) -> IpNextHeaderProtocol
[src]
pub fn get_next_level_protocol(&self) -> IpNextHeaderProtocol
[src]Get the value of the {name} field
pub fn get_checksum(&self) -> u16be
[src]
pub fn get_checksum(&self) -> u16be
[src]Get the checksum field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_source(&self) -> Ipv4Addr
[src]
pub fn get_source(&self) -> Ipv4Addr
[src]Get the value of the {name} field
pub fn get_destination(&self) -> Ipv4Addr
[src]
pub fn get_destination(&self) -> Ipv4Addr
[src]Get the value of the {name} field
pub fn get_options_raw(&self) -> &[u8]
[src]
pub fn get_options_raw(&self) -> &[u8]
[src]Get the raw &u8 value of the {name} field, without copying
pub fn get_options(&self) -> Vec<Ipv4Option>
[src]
pub fn get_options(&self) -> Vec<Ipv4Option>
[src]Get the value of the {name} field (copies contents)
pub fn get_options_iter(&self) -> Ipv4OptionIterable<'_>ⓘNotable traits for Ipv4OptionIterable<'a>
impl<'a> Iterator for Ipv4OptionIterable<'a> type Item = Ipv4OptionPacket<'a>;
[src]
pub fn get_options_iter(&self) -> Ipv4OptionIterable<'_>ⓘNotable traits for Ipv4OptionIterable<'a>
impl<'a> Iterator for Ipv4OptionIterable<'a> type Item = Ipv4OptionPacket<'a>;
[src]Get the value of the {name} field as iterator
pub fn get_payload(&self) -> Vec<u8>
[src]
pub fn get_payload(&self) -> Vec<u8>
[src]Get the value of the {name} field (copies contents)
pub fn set_version(&mut self, val: u4)
[src]
pub fn set_version(&mut self, val: u4)
[src]Set the version field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_header_length(&mut self, val: u4)
[src]
pub fn set_header_length(&mut self, val: u4)
[src]Set the header_length field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_dscp(&mut self, val: u6)
[src]
pub fn set_dscp(&mut self, val: u6)
[src]Set the dscp field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_ecn(&mut self, val: u2)
[src]
pub fn set_ecn(&mut self, val: u2)
[src]Set the ecn field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_total_length(&mut self, val: u16be)
[src]
pub fn set_total_length(&mut self, val: u16be)
[src]Set the total_length field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_identification(&mut self, val: u16be)
[src]
pub fn set_identification(&mut self, val: u16be)
[src]Set the identification field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_flags(&mut self, val: u3)
[src]
pub fn set_flags(&mut self, val: u3)
[src]Set the flags field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_fragment_offset(&mut self, val: u13be)
[src]
pub fn set_fragment_offset(&mut self, val: u13be)
[src]Set the fragment_offset field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_ttl(&mut self, val: u8)
[src]
pub fn set_ttl(&mut self, val: u8)
[src]Set the ttl field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_next_level_protocol(&mut self, val: IpNextHeaderProtocol)
[src]
pub fn set_next_level_protocol(&mut self, val: IpNextHeaderProtocol)
[src]Set the value of the {name} field.
pub fn set_checksum(&mut self, val: u16be)
[src]
pub fn set_checksum(&mut self, val: u16be)
[src]Set the checksum field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_source(&mut self, val: Ipv4Addr)
[src]
pub fn set_source(&mut self, val: Ipv4Addr)
[src]Set the value of the {name} field.
pub fn set_destination(&mut self, val: Ipv4Addr)
[src]
pub fn set_destination(&mut self, val: Ipv4Addr)
[src]Set the value of the {name} field.
pub fn get_options_raw_mut(&mut self) -> &mut [u8]
[src]
pub fn get_options_raw_mut(&mut self) -> &mut [u8]
[src]Get the raw &mut u8 value of the {name} field, without copying
pub fn set_options(&mut self, vals: &[Ipv4Option])
[src]
pub fn set_options(&mut self, vals: &[Ipv4Option])
[src]Set the value of the {name} field (copies contents)
pub fn set_payload(&mut self, vals: &[u8])
[src]
pub fn set_payload(&mut self, vals: &[u8])
[src]Set the value of the {name} field (copies contents)
Trait Implementations
impl<'p> Debug for MutableIpv4Packet<'p>
[src]
impl<'p> Debug for MutableIpv4Packet<'p>
[src]impl<'p> FromPacket for MutableIpv4Packet<'p>
[src]
impl<'p> FromPacket for MutableIpv4Packet<'p>
[src]fn from_packet(&self) -> Ipv4
[src]
fn from_packet(&self) -> Ipv4
[src]Converts a wire-format packet to #[packet] struct format.
impl<'a> MutablePacket for MutableIpv4Packet<'a>
[src]
impl<'a> MutablePacket for MutableIpv4Packet<'a>
[src]fn packet_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]
fn packet_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]Retreive the underlying, mutable, buffer for the packet.
fn payload_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]
fn payload_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]Retreive the mutable payload for the packet.
fn clone_from<T>(&mut self, other: &T) where
T: Packet,
[src]
fn clone_from<T>(&mut self, other: &T) where
T: Packet,
[src]Initialize this packet by cloning another.
impl<'a> Packet for MutableIpv4Packet<'a>
[src]
impl<'a> Packet for MutableIpv4Packet<'a>
[src]impl<'a> PacketSize for MutableIpv4Packet<'a>
[src]
impl<'a> PacketSize for MutableIpv4Packet<'a>
[src]fn packet_size(&self) -> usize
[src]
fn packet_size(&self) -> usize
[src]Get the calculated size of the packet.
impl<'p> PartialEq<MutableIpv4Packet<'p>> for MutableIpv4Packet<'p>
[src]
impl<'p> PartialEq<MutableIpv4Packet<'p>> for MutableIpv4Packet<'p>
[src]fn eq(&self, other: &MutableIpv4Packet<'p>) -> bool
[src]
fn eq(&self, other: &MutableIpv4Packet<'p>) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &MutableIpv4Packet<'p>) -> bool
[src]
fn ne(&self, other: &MutableIpv4Packet<'p>) -> bool
[src]This method tests for !=
.