Struct Config 

pub struct Config {
    pub path: PathBuf,
    pub lease_time: LeaseTime,
    pub rapid_commit: bool,
    pub network_cidr: Ipv4Network,
    pub listen_address: SocketAddrV4,
    pub interface: Option<String>,
    pub server_address: Option<Ipv4Addr>,
    pub parameters: HashMap<String, MessageOptions>,
    pub static_leases: HashMap<MacAddress, Ipv4Addr>,
    pub use_leases_file: bool,
}

Representation of a toe-beans.toml file. Used by the Server.

This is exported for you to use in your application to generate a toe-beans.toml.

Fields

path: PathBuf

The path to a directory where this config will exist on disk.

lease_time: LeaseTime

See: LeaseTime

rapid_commit: bool

Controls whether the server agrees to use Rapid Commit.

network_cidr: Ipv4Network

A range of IP addresses for the server to lease. Specified in CIDR notation. For example: 10.1.9.32/16

listen_address: SocketAddrV4

The server will bind to this address and port.

interface: Option<String>

The name of the network interface to broadcast server responses to. Currently only takes one interface.

server_address: Option<Ipv4Addr>

May or may not match the IP address in listen_address. For example, you might be listening to 0.0.0.0, but your server has another address it can be reached from. This is used in both the siaddr field and ServerIdentifier option.

If None, then listen_address is used.

parameters: HashMap<String, MessageOptions>

DHCP option numbers (as a String) mapped to values that are used to respond to parameter request list options Please note that this field, in particular, is subject to change.

static_leases: HashMap<MacAddress, Ipv4Addr>

This is passed to Leases’s static_leases field.

use_leases_file: bool

Whether to read and write leases to a file to maintain state between server restarts. Defaults to true (when not in a benchmark or integration test) but you might want to set to false for performance, lack of storage, etc.

Implementations

impl Config

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

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

pub fn read(from_where: PathBuf) -> Self

Reads the toe-beans.toml file and deserializes it into a Config. Returns default options if there are any issues.

pub fn write(&self)

Serializes a Config and writes it to a toe-beans.toml file.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.