Struct BridgeHostState

pub struct BridgeHostState { /* private fields */ }

The state of bridges that are actively known on this host.

This is effectively just a list of bridges along with one of those being set as the “default” bridge. A lot of this configuration is stored within a system level directory, see BridgeHostState::get_default_host_path.

Implementations

impl BridgeHostState

pub async fn load() -> Result<Self, FSError>

Attempt to load the bridge host state from the filesystem.

This is commonly referred to as bridge_env.ini, stored normally in Windows under the %APPDATA%\bridge_env.ini file. This is where tools like getbridge/hostdisplayversion/setbridge store which bridges you actually use, and which one you’ve set as the default bridge.

Errors

• If we cannot get the default host path for your OS.
• Any error case from BridgeHostState::load_explicit_path.

pub async fn load_explicit_path(path: PathBuf) -> Result<Self, FSError>

Attempt to load the bridge host state file from the filesystem.

This is commonly referred to as bridge_env.ini, and is a small Windows (so UTF8) ini file, separated by newlines being \r\n.

Errors

• If we cannot read from the file on the file system.
• If we cannot parse the data in the file as UTF8.
• If we cannot parse the data as an INI file.

pub fn get_default_bridge(&self) -> Option<(String, Option<Ipv4Addr>)>

Grab the currently configured default host bridge.

This returns an option (representing if any default has been configured), and then will return an option for the ip address as the name could potentially point to a name that doesn’t have an ip address set, or one that doesn’t have a valid IPv4 address (as bridges are required to be IPv4).

pub fn get_bridge(&self, bridge_name: &str) -> Option<(Option<Ipv4Addr>, bool)>

Get an actively configured bridge.

Returns (BridgeIP, IsDefault), if a bridge is actively configured.

pub fn list_bridges(&self) -> FnvHashMap<String, (Option<Ipv4Addr>, bool)>

List all the bridges that are actively configured.

Returns a map of <BridgeName, (BridgeIP, IsDefault)>. The Bridge IP will be an empty option if we could not parse the value as an IPv4 Address (i.e. the value is invalid), or the key did not have a value.

pub fn upsert_bridge( &mut self, bridge_name: &str, bridge_ip: Ipv4Addr, ) -> Result<(), MIONAPIError>

Insert a new bridge, or update it’s value.

note: this will be visible in memory immediately, but in order to persist it, or have it seen in another process you need to call BridgeHostState::write_to_disk.

Errors

If the bridge name is not ascii. If the bridge name is empty. If the bridge name is too long.

pub fn remove_bridge(&mut self, bridge_name: &str)

Remove a bridge from the configuration file.

note: this will be visible in memory immediately, but in order to persist it, or have it seen in another process you need to call BridgeHostState::write_to_disk.

pub fn remove_default_bridge(&mut self)

Remove the default bridge key from the configuration file.

note: this will be visible in memory immediately, but in order to persist it, or have it seen in another process you need to call BridgeHostState::write_to_disk.

pub fn set_default_bridge( &mut self, bridge_name: &str, ) -> Result<(), MIONAPIError>

Set the default bridge for your host.

Errors

If you try setting the default bridge to a bridge that does not exist. If your device name is not ascii. If your device name is empty. If your device name is too long.

pub async fn write_to_disk(&self) -> Result<(), FSError>

Write the current configuration to disk as a Windows INI file.

We always write the file with carriage returns \r\n (windows line endings), and in UTF-8. So we can always copy-paste the file onto a windows host and have it be read by the official tools without issue.

Errors

If we run into a system error when writing the file to the disk.

pub fn get_path(&self) -> &PathBuf

Get the path the Bridge Host State file was being loaded from.

pub fn get_default_host_path() -> Option<PathBuf>

Get the default path that the bridge host state is supposed to be stored in.

NOTE: this directory is not necissarily guaranteed to exist.

Returns none when we can’t find an appropriate path to store bridge host state in.

Trait Implementations

impl Clone for BridgeHostState

fn clone(&self) -> BridgeHostState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BridgeHostState

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

Formats the value using the given formatter.

impl PartialEq for BridgeHostState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BridgeHostState

impl StructuralPartialEq for BridgeHostState