Struct libpacket::gre::MutableGrePacket [−][src]
pub struct MutableGrePacket<'p> { /* fields omitted */ }
Expand description
A structure enabling manipulation of on the wire packets
Implementations
impl<'a> MutableGrePacket<'a>
[src]
impl<'a> MutableGrePacket<'a>
[src]pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableGrePacket<'p>>
[src]
pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableGrePacket<'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<MutableGrePacket<'static>>
[src]
pub fn owned(packet: Vec<u8>) -> Option<MutableGrePacket<'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) -> GrePacket<'p>
[src]
pub fn to_immutable<'p>(&'p self) -> GrePacket<'p>
[src]Maps from a #name to a #imm_name
pub fn consume_to_immutable(self) -> GrePacket<'a>
[src]
pub fn consume_to_immutable(self) -> GrePacket<'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: &Gre) -> usize
[src]
pub fn packet_size(_packet: &Gre) -> usize
[src]The size (in bytes) of a #base_name 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. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_routing_present(&self) -> u1
[src]
pub fn get_routing_present(&self) -> u1
[src]Get the routing_present field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_key_present(&self) -> u1
[src]
pub fn get_key_present(&self) -> u1
[src]Get the key_present field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_sequence_present(&self) -> u1
[src]
pub fn get_sequence_present(&self) -> u1
[src]Get the sequence_present field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_strict_source_route(&self) -> u1
[src]
pub fn get_strict_source_route(&self) -> u1
[src]Get the strict_source_route field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_recursion_control(&self) -> u3
[src]
pub fn get_recursion_control(&self) -> u3
[src]Get the recursion_control field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_zero_flags(&self) -> u5
[src]
pub fn get_zero_flags(&self) -> u5
[src]Get the zero_flags field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_version(&self) -> u3
[src]
pub fn get_version(&self) -> u3
[src]Get the version field. This field is always stored big-endian within the struct, but this accessor returns host order.
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 {name} field, without copying
pub fn get_checksum(&self) -> Vec<U16BE>
[src]
pub fn get_checksum(&self) -> Vec<U16BE>
[src]Get the value of the {name} 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 {name} 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 {name} field, without copying
pub fn get_offset(&self) -> Vec<U16BE>
[src]
pub fn get_offset(&self) -> Vec<U16BE>
[src]Get the value of the {name} 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 {name} 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 {name} 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 {name} field, without copying
pub fn get_sequence(&self) -> Vec<U32BE>
[src]
pub fn get_sequence(&self) -> Vec<U32BE>
[src]Get the value of the {name} 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 {name} 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 {name} field, without copying
pub fn get_routing(&self) -> Vec<u8>
[src]
pub fn get_routing(&self) -> Vec<u8>
[src]Get the value of the {name} field (copies contents)
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_checksum_present(&mut self, val: u1)
[src]
pub fn set_checksum_present(&mut self, val: u1)
[src]Set the checksum_present field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_routing_present(&mut self, val: u1)
[src]
pub fn set_routing_present(&mut self, val: u1)
[src]Set the routing_present field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_key_present(&mut self, val: u1)
[src]
pub fn set_key_present(&mut self, val: u1)
[src]Set the key_present field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_sequence_present(&mut self, val: u1)
[src]
pub fn set_sequence_present(&mut self, val: u1)
[src]Set the sequence_present field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_strict_source_route(&mut self, val: u1)
[src]
pub fn set_strict_source_route(&mut self, val: u1)
[src]Set the strict_source_route field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_recursion_control(&mut self, val: u3)
[src]
pub fn set_recursion_control(&mut self, val: u3)
[src]Set the recursion_control field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_zero_flags(&mut self, val: u5)
[src]
pub fn set_zero_flags(&mut self, val: u5)
[src]Set the zero_flags field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_version(&mut self, val: u3)
[src]
pub fn set_version(&mut self, val: u3)
[src]Set the version field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_protocol_type(&mut self, val: u16be)
[src]
pub fn set_protocol_type(&mut self, val: u16be)
[src]Set the protocol_type field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn get_checksum_raw_mut(&mut self) -> &mut [u8]
[src]
pub fn get_checksum_raw_mut(&mut self) -> &mut [u8]
[src]Get the raw &mut u8 value of the {name} field, without copying
pub fn set_checksum(&mut self, vals: &[U16BE])
[src]
pub fn set_checksum(&mut self, vals: &[U16BE])
[src]Set the value of the {name} field (copies contents)
pub fn get_offset_raw_mut(&mut self) -> &mut [u8]
[src]
pub fn get_offset_raw_mut(&mut self) -> &mut [u8]
[src]Get the raw &mut u8 value of the {name} field, without copying
pub fn set_offset(&mut self, vals: &[U16BE])
[src]
pub fn set_offset(&mut self, vals: &[U16BE])
[src]Set the value of the {name} field (copies contents)
pub fn get_key_raw_mut(&mut self) -> &mut [u8]
[src]
pub fn get_key_raw_mut(&mut self) -> &mut [u8]
[src]Get the raw &mut u8 value of the {name} field, without copying
pub fn get_sequence_raw_mut(&mut self) -> &mut [u8]
[src]
pub fn get_sequence_raw_mut(&mut self) -> &mut [u8]
[src]Get the raw &mut u8 value of the {name} field, without copying
pub fn set_sequence(&mut self, vals: &[U32BE])
[src]
pub fn set_sequence(&mut self, vals: &[U32BE])
[src]Set the value of the {name} field (copies contents)
pub fn get_routing_raw_mut(&mut self) -> &mut [u8]
[src]
pub fn get_routing_raw_mut(&mut self) -> &mut [u8]
[src]Get the raw &mut u8 value of the {name} field, without copying
pub fn set_routing(&mut self, vals: &[u8])
[src]
pub fn set_routing(&mut self, vals: &[u8])
[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 MutableGrePacket<'p>
[src]
impl<'p> Debug for MutableGrePacket<'p>
[src]impl<'p> FromPacket for MutableGrePacket<'p>
[src]
impl<'p> FromPacket for MutableGrePacket<'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> MutablePacket for MutableGrePacket<'a>
[src]
impl<'a> MutablePacket for MutableGrePacket<'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 MutableGrePacket<'a>
[src]
impl<'a> Packet for MutableGrePacket<'a>
[src]impl<'a> PacketSize for MutableGrePacket<'a>
[src]
impl<'a> PacketSize for MutableGrePacket<'a>
[src]fn packet_size(&self) -> usize
[src]
fn packet_size(&self) -> usize
[src]Get the calculated size of the packet.
impl<'p> PartialEq<MutableGrePacket<'p>> for MutableGrePacket<'p>
[src]
impl<'p> PartialEq<MutableGrePacket<'p>> for MutableGrePacket<'p>
[src]fn eq(&self, other: &MutableGrePacket<'p>) -> bool
[src]
fn eq(&self, other: &MutableGrePacket<'p>) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &MutableGrePacket<'p>) -> bool
[src]
fn ne(&self, other: &MutableGrePacket<'p>) -> bool
[src]This method tests for !=
.