Struct pnet_packet::gre::GrePacket [−][src]
pub struct GrePacket<'p> { /* fields omitted */ }
Expand description
A structure enabling manipulation of on the wire packets
Implementations
impl<'a> GrePacket<'a>
[src]
impl<'a> GrePacket<'a>
[src]pub fn new<'p>(packet: &'p [u8]) -> Option<GrePacket<'p>>
[src]
pub fn new<'p>(packet: &'p [u8]) -> Option<GrePacket<'p>>
[src]Constructs a new GrePacket. If the provided buffer is less than the minimum required packet size, this will return None.
pub fn owned(packet: Vec<u8>) -> Option<GrePacket<'static>>
[src]
pub fn owned(packet: Vec<u8>) -> Option<GrePacket<'static>>
[src]Constructs a new GrePacket. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the GrePacket will own its own data and the underlying buffer will be dropped when the GrePacket is.
pub fn to_immutable<'p>(&'p self) -> GrePacket<'p>
[src]
pub fn to_immutable<'p>(&'p self) -> GrePacket<'p>
[src]Maps from a GrePacket to a GrePacket
pub fn consume_to_immutable(self) -> GrePacket<'a>
[src]
pub fn consume_to_immutable(self) -> GrePacket<'a>
[src]Maps from a GrePacket to a GrePacket 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: &Gre) -> usize
[src]
pub fn packet_size(_packet: &Gre) -> usize
[src]The size (in bytes) of a Gre instance when converted into a byte-array
pub fn get_checksum_present(&self) -> u1
[src]
pub fn get_checksum_present(&self) -> u1
[src]Get the checksum_present field.
pub fn get_routing_present(&self) -> u1
[src]
pub fn get_routing_present(&self) -> u1
[src]Get the routing_present field.
pub fn get_key_present(&self) -> u1
[src]
pub fn get_key_present(&self) -> u1
[src]Get the key_present field.
pub fn get_sequence_present(&self) -> u1
[src]
pub fn get_sequence_present(&self) -> u1
[src]Get the sequence_present field.
pub fn get_strict_source_route(&self) -> u1
[src]
pub fn get_strict_source_route(&self) -> u1
[src]Get the strict_source_route field.
pub fn get_recursion_control(&self) -> u3
[src]
pub fn get_recursion_control(&self) -> u3
[src]Get the recursion_control field.
pub fn get_zero_flags(&self) -> u5
[src]
pub fn get_zero_flags(&self) -> u5
[src]Get the zero_flags field.
pub fn get_version(&self) -> u3
[src]
pub fn get_version(&self) -> u3
[src]Get the version field.
pub fn get_protocol_type(&self) -> u16be
[src]
pub fn get_protocol_type(&self) -> u16be
[src]Get the protocol_type field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_checksum_raw(&self) -> &[u8]
[src]
pub fn get_checksum_raw(&self) -> &[u8]
[src]Get the raw &u8 value of the checksum field, without copying
pub fn get_checksum(&self) -> Vec<U16BE>
[src]
pub fn get_checksum(&self) -> Vec<U16BE>
[src]Get the value of the checksum field (copies contents)
pub fn get_checksum_iter(&self) -> U16BEIterable<'_>ⓘNotable traits for U16BEIterable<'a>
impl<'a> Iterator for U16BEIterable<'a> type Item = U16BEPacket<'a>;
[src]
pub fn get_checksum_iter(&self) -> U16BEIterable<'_>ⓘNotable traits for U16BEIterable<'a>
impl<'a> Iterator for U16BEIterable<'a> type Item = U16BEPacket<'a>;
[src]Get the value of the checksum field as iterator
pub fn get_offset_raw(&self) -> &[u8]
[src]
pub fn get_offset_raw(&self) -> &[u8]
[src]Get the raw &u8 value of the offset field, without copying
pub fn get_offset(&self) -> Vec<U16BE>
[src]
pub fn get_offset(&self) -> Vec<U16BE>
[src]Get the value of the offset field (copies contents)
pub fn get_offset_iter(&self) -> U16BEIterable<'_>ⓘNotable traits for U16BEIterable<'a>
impl<'a> Iterator for U16BEIterable<'a> type Item = U16BEPacket<'a>;
[src]
pub fn get_offset_iter(&self) -> U16BEIterable<'_>ⓘNotable traits for U16BEIterable<'a>
impl<'a> Iterator for U16BEIterable<'a> type Item = U16BEPacket<'a>;
[src]Get the value of the offset field as iterator
pub fn get_key_iter(&self) -> U32BEIterable<'_>ⓘNotable traits for U32BEIterable<'a>
impl<'a> Iterator for U32BEIterable<'a> type Item = U32BEPacket<'a>;
[src]
pub fn get_key_iter(&self) -> U32BEIterable<'_>ⓘNotable traits for U32BEIterable<'a>
impl<'a> Iterator for U32BEIterable<'a> type Item = U32BEPacket<'a>;
[src]Get the value of the key field as iterator
pub fn get_sequence_raw(&self) -> &[u8]
[src]
pub fn get_sequence_raw(&self) -> &[u8]
[src]Get the raw &u8 value of the sequence field, without copying
pub fn get_sequence(&self) -> Vec<U32BE>
[src]
pub fn get_sequence(&self) -> Vec<U32BE>
[src]Get the value of the sequence field (copies contents)
pub fn get_sequence_iter(&self) -> U32BEIterable<'_>ⓘNotable traits for U32BEIterable<'a>
impl<'a> Iterator for U32BEIterable<'a> type Item = U32BEPacket<'a>;
[src]
pub fn get_sequence_iter(&self) -> U32BEIterable<'_>ⓘNotable traits for U32BEIterable<'a>
impl<'a> Iterator for U32BEIterable<'a> type Item = U32BEPacket<'a>;
[src]Get the value of the sequence field as iterator
pub fn get_routing_raw(&self) -> &[u8]
[src]
pub fn get_routing_raw(&self) -> &[u8]
[src]Get the raw &u8 value of the routing field, without copying
pub fn get_routing(&self) -> Vec<u8>
[src]
pub fn get_routing(&self) -> Vec<u8>
[src]Get the value of the routing field (copies contents)
Trait Implementations
impl<'p> FromPacket for GrePacket<'p>
[src]
impl<'p> FromPacket for GrePacket<'p>
[src]fn from_packet(&self) -> Gre
[src]
fn from_packet(&self) -> Gre
[src]Converts a wire-format packet to #[packet] struct format.
impl<'a> PacketSize for GrePacket<'a>
[src]
impl<'a> PacketSize for GrePacket<'a>
[src]fn packet_size(&self) -> usize
[src]
fn packet_size(&self) -> usize
[src]Get the calculated size of the packet.