Struct brane_cli::instance::InstanceInfo

pub struct InstanceInfo {
    pub api: Address,
    pub drv: Address,
    pub user: String,
}

Defines the layout of an InstanceInfo, which describes what we remember about each instance.

Note that the name is encoded as the file’s name.

Fields

api: Address

The place where we can find the API service for this instance.

drv: Address

The place where we can find the driver service for this instance.

user: String

A username to send with workflow requests as receiver of the final result.

Implementations

impl InstanceInfo

pub fn from_active_path() -> Result<Self, Error>

Reads this InstanceInfo from the active instance’s directory in the local configuration directory.

Returns

A new InstanceInfo instance that is populated with the contents of the file pointed to by the active-instance symlink.

Errors

This function errors if we failed to get the local path, there is no active instance, if we failed to read the file or if we failed to parse it.

pub fn active_instance_exists() -> Result<bool, Error>

Asserts whether there is a selected instance or nay.

Returns

true if there is an active instance link, or false otherwise.

Errors

This function errors if we failed to get the default link path.

pub fn from_default_path(name: impl AsRef<str>) -> Result<Self, Error>

Reads this InstanceInfo from the default path in the local configuration directory.

Arguments

• name: The name for this instance. Will cause errors if it contains characters incompatible for paths of OS.

Returns

A new InstanceInfo instance that is populated with the contents of the file.

Errors

This function errors if we failed to get the local path, if we failed to read the file or if we failed to parse it.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, Error>

Reads this InstanceInfo from the given path.

Arguments

• path: The path to read it from.

Returns

A new InstanceInfo instance that is populated with the contents of the file.

Errors

This function errors if we failed to read the file or if we failed to parse it.

pub fn get_active_name() -> Result<String, Error>

Computes the name of the active instance and returns it.

Returns

The name of the instance currently set active.

Errors

This function errors if we failed to get the active instance or read the file.

pub fn get_active_path() -> Result<PathBuf, Error>

Computes the active path and returns it.

This is not the path of the active instance link itself, but rather the instance it points to.

Returns

The path to the active instance.

Errors

This function errors if we failed to get the local path, or there is no active instance.

pub fn get_instance_path(name: impl AsRef<str>) -> Result<PathBuf, Error>

Computes the path to the directory of the instance with the given name.

Arguments

• name: The name of the instance to get the directory of.

Returns

The path to this instance’s directory.

Errors

This function may error if we failed to get the base config directory, or no such instance exists.

Trait Implementations

impl Clone for InstanceInfo

fn clone(&self) -> InstanceInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstanceInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for InstanceInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.