Struct dhcproto::v4::relay::RelayAgentInformation

pub struct RelayAgentInformation(_);

Collection of relay agent information

You can create/modify it, then insert into a message opts section in DhcpOption::RelayAgentInformation

use dhcproto::v4::{self, relay::{RelayInfo, RelayAgentInformation}};

let mut info = RelayAgentInformation::default();
info.insert(RelayInfo::LinkSelection("1.2.3.4".parse().unwrap()));
let mut msg = v4::Message::default();
msg.opts_mut()
    .insert(v4::DhcpOption::RelayAgentInformation(info));

Implementations

impl RelayAgentInformation

pub fn get(&self, code: RelayCode) -> Option<&RelayInfo>

Get the data for a particular RelayCode

pub fn get_mut(&mut self, code: RelayCode) -> Option<&mut RelayInfo>

Get the mutable data for a particular RelayCode

pub fn remove(&mut self, code: RelayCode) -> Option<RelayInfo>

remove sub option

pub fn insert(&mut self, info: RelayInfo) -> Option<RelayInfo>

insert a new RelayInfo

pub fn iter(&self) -> impl Iterator<Item = (&RelayCode, &RelayInfo)>

iterate over entries

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&RelayCode, &mut RelayInfo)>

iterate mutably over entries

pub fn clear(&mut self)

clear all options

pub fn is_empty(&self) -> bool

Returns true if there are no options

pub fn retain<F>(&mut self, pred: F) where
    F: FnMut(&RelayCode, &mut RelayInfo) -> bool, 

Retans only the elements specified by the predicate

Trait Implementations

impl Clone for RelayAgentInformation

fn clone(&self) -> RelayAgentInformation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RelayAgentInformation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decodable for RelayAgentInformation

fn decode(d: &mut Decoder<'_>) -> DecodeResult<Self>

Read the type from the stream

fn from_bytes(bytes: &[u8]) -> DecodeResult<Self>

Returns the object in binary form

impl Default for RelayAgentInformation

fn default() -> RelayAgentInformation

Returns the “default value” for a type.

impl Encodable for RelayAgentInformation

fn encode(&self, e: &mut Encoder<'_>) -> EncodeResult<()>

Read the type from the stream

fn to_vec(&self) -> EncodeResult<Vec<u8>>

encode this type into a new Vec

impl PartialEq<RelayAgentInformation> for RelayAgentInformation

fn eq(&self, other: &RelayAgentInformation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RelayAgentInformation) -> bool

This method tests for !=.

impl Eq for RelayAgentInformation

impl StructuralEq for RelayAgentInformation

impl StructuralPartialEq for RelayAgentInformation