Struct Leases 

pub struct Leases { /* private fields */ }

Used to manage the dynamic collection of IP addresses that the server leases.

Implementations

impl Leases

pub const FILE_NAME: &'static str = "toe-beans-leases.toml"

The file name that the Leases is read from and written to.

pub fn new(config: &Config) -> Self

Depending on whether the passed Config enables use_leases_file: Restore and validate the leases file or create a new, empty Leases.

pub fn offer( &mut self, owner: MacAddress, requested_ip: Option<Ipv4Addr>, ) -> Result<Ipv4Addr>

Takes an available IP address, marks it as offered, and returns it.

Returns one of:

• The previously offered address, if one has been offered.
• The requested address:
  • If one was requested,
  • and it is available,
  • and there is not a static lease
• Otherwise any available address (unless none are available).

pub fn ack(&mut self, owner: MacAddress) -> Result<Ipv4Addr>

Takes a chaddr’s offered ip address and marks it as reserved then commits it to persistent storage and returns the address.

pub fn extend(&mut self, owner: MacAddress) -> Result<()>

Resets the time of an offered or acked lease. Used by the server in the lease renew/rebind process.

pub fn release(&mut self, owner: MacAddress) -> Result<()>

Makes an ip address that was offered or acked available again.

pub fn is_available(&self, ip: &Ipv4Addr) -> bool

Checks whether the passed IP address is available in the pool.

pub fn verify_lease(&self, owner: MacAddress, ip: &Ipv4Addr) -> Result<()>

Checks if the passed IP address matches the committed, leased IP address, and that the lease is not expired.

Trait Implementations

impl<'de> Deserialize<'de> for Leases

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Leases

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.