Struct dhcpv4::stash::Stash

pub struct Stash { /* private fields */ }

A wrapper around a fuchsia.stash.StoreAccessor proxy.

Stash provides a simple API by which the DHCP Server can store and load client configuration data to persistent storage.

This wrapper stores client configuration as serialized JSON strings. The decision to use JSON derives from its use in other Stash clients, cf. commit e9c57a0, and the relative immaturity of more compact serde serialization formats, e.g. https://github.com/pyfisch/cbor/issues.

Implementations

impl Stash

pub fn new(id: &str) -> Result<Self, StashError>

Instantiates a new Stash value.

The newly instantiated value will use id to identify itself with the fuchsia.stash service.

pub async fn load_client_records(&self) -> Result<ClientRecords, StashError>

Loads a ClientRecords map from data stored in fuchsia.stash.

This function will retrieve all client configuration data from fuchsia.stash, deserialize the JSON string values, and load the resulting structured data into a ClientRecords hashmap. Any key-value pair which could not be parsed or deserialized will be removed and skipped.

pub async fn load_options( &self ) -> Result<HashMap<OptionCode, DhcpOption>, StashError>

Loads a map of OptionCodes to DhcpOptions from data stored in fuchsia.stash.

pub async fn load_parameters(&self) -> Result<ServerParameters, StashError>

Loads a new instance of ServerParameters from data stored in fuchsia.stash.

pub fn clear(&self) -> Result<(), StashError>

Clears all configuration data from fuchsia.stash.

This function will delete all key-value pairs associated with the Stash value.

Trait Implementations

impl Clone for Stash

fn clone(&self) -> Stash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataStore for Stash

type Error = StashError

fn insert( &mut self, client_id: &ClientIdentifier, client_record: &LeaseRecord ) -> Result<(), Self::Error>

Inserts the client record associated with the identifier.

fn store_options(&mut self, opts: &[DhcpOption]) -> Result<(), Self::Error>

Stores the DHCP option values served by the server.

fn store_parameters( &mut self, params: &ServerParameters ) -> Result<(), Self::Error>

Stores the DHCP server’s configuration parameters.

fn delete(&mut self, client_id: &ClientIdentifier) -> Result<(), Self::Error>

Deletes the client record associated with the identifier.

impl Debug for Stash

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

Formats the value using the given formatter.