Struct netsim_embed::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]

`pub fn new(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, Global>) -> 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 self) -> GrePacket<'p>`[src]

Maps from a #name to a #imm_name

`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]

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]

The size (in bytes) of a #base_name instance when converted into a byte-array

`pub fn populate(&mut self, packet: &Gre)`[src]

Populates a {name}Packet using a {name} structure

`pub fn get_checksum_present(&self) -> u8`[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) -> u8`[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) -> u8`[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) -> u8`[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) -> u8`[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) -> u8`[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) -> u8`[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) -> u8`[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) -> u16`[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]

Get the raw &u8 value of the {name} field, without copying

`pub fn get_checksum(&self) -> Vec<U16BE, Global>`[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]

Get the value of the {name} field as iterator

`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, Global>`[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]

Get the value of the {name} field as iterator

`pub fn get_key_raw(&self) -> &[u8]`[src]

Get the raw &u8 value of the {name} field, without copying

`pub fn get_key(&self) -> Vec<U32BE, Global>`[src]

Get the value of the {name} field (copies contents)

`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]

Get the raw &u8 value of the {name} field, without copying

`pub fn get_sequence(&self) -> Vec<U32BE, Global>`[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]

Get the value of the {name} field as iterator

`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, Global>`[src]

Get the value of the {name} field (copies contents)

`pub fn get_payload(&self) -> Vec<u8, Global>`[src]

Get the value of the {name} field (copies contents)

`pub fn set_checksum_present(&mut self, val: u8)`[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: u8)`[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: u8)`[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: u8)`[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: u8)`[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: u8)`[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: u8)`[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: u8)`[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: u16)`[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]

Get the raw &mut u8 value of the {name} field, without copying

`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]

Get the raw &mut u8 value of the {name} field, without copying

`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]

Get the raw &mut u8 value of the {name} field, without copying

`pub fn set_key(&mut self, vals: &[U32BE])`[src]

Set the value of the {name} field (copies contents)

`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]

Set the value of the {name} field (copies contents)

`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]

Set the value of the {name} field (copies contents)

`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]

`pub fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

`impl<'p> FromPacket for MutableGrePacket<'p>`[src]

`type T = Gre`

The type of the packet to convert from.

`pub fn from_packet(&self) -> Gre`[src]

Converts a wire-format packet to #[packet] struct format.

`impl<'a> MutablePacket for MutableGrePacket<'a>`[src]

`pub fn packet_mut(&'p mut self) -> &'p mut [u8]`[src]

Retreive the underlying, mutable, buffer for the packet.

`pub fn payload_mut(&'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,`

Initialize this packet by cloning another.

`impl<'a> Packet for MutableGrePacket<'a>`[src]

`pub fn packet(&'p self) -> &'p [u8]`[src]

Retrieve the underlying buffer for the packet.

`pub fn payload(&'p self) -> &'p [u8]`[src]

Retrieve the payload for the packet.

`impl<'a> PacketSize for MutableGrePacket<'a>`[src]

`pub fn packet_size(&self) -> usize`[src]

Get the calculated size of the packet.

`impl<'p> PartialEq<MutableGrePacket<'p>> for MutableGrePacket<'p>`[src]

`pub 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

`pub fn ne(&self, other: &MutableGrePacket<'p>) -> bool`[src]

This method tests for !=.

`impl<'p> StructuralPartialEq for MutableGrePacket<'p>`[src]

Auto Trait Implementations

`impl<'p> RefUnwindSafe for MutableGrePacket<'p>`

`impl<'p> Send for MutableGrePacket<'p>`

`impl<'p> Sync for MutableGrePacket<'p>`

`impl<'p> Unpin for MutableGrePacket<'p>`

`impl<'p> !UnwindSafe for MutableGrePacket<'p>`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

Performs the conversion.

`impl<T> Instrument for T`[src]

`fn instrument(self, span: Span) -> Instrumented<Self>`[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

`fn in_current_span(self) -> Instrumented<Self>`[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

Performs the conversion.

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

`impl<V, T> VZip<V> for T where V: MultiLane<T>,`

`pub fn vzip(self) -> V`