Struct the_process_foundry::base::AppInstance

pub struct AppInstance {
    pub instance_id: Option<String>,
    pub name: String,
    pub version: Option<Version>,
    pub module_version: Option<Version>,
    pub config_file: Option<String>,
    pub cli: Option<CliAccess>,
    pub api: Option<ApiAccess>,
}

Information about the specific running copy of the external program

This is a synthesis of both introspected information (version) and external (ip address/port) THINK: Should this identify the environment? THINK: Should the app instance know itself/functions?

Fields

instance_id: Option<String>

This is for use by Containers enumerating instances of their content

name: String

The standard name for this app (e.g. Postgres, DockerCompose)

version: Option<Version>

The version of the installed app NOTE: Some items (like sh), don't easily have a version available, so we make it optional

module_version: Option<Version>

The version of the Foundry code running NOTE: This will be much more important once TPF becomes distributed microservices

config_file: Option<String>

cli: Option<CliAccess>

api: Option<ApiAccess>

Implementations

impl AppInstance

pub fn new(name: String) -> AppInstance

pub fn full_name(&self) -> String

pub fn set_command_path(
    &self,
    container: Option<Rc<dyn ContainerTrait>>,
    path: String
) -> Result<AppInstance>

pub fn get_command_path(&self) -> Result<String>

Trait Implementations

impl Clone for AppInstance

fn clone(&self) -> AppInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppInstance

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

Formats the value using the given formatter.

impl Default for AppInstance

fn default() -> AppInstance

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for AppInstance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for AppInstance

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

Formats the value using the given formatter.

impl Serialize for AppInstance

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

Serialize this value into the given Serde serializer.