Struct igloo_core::Igloo

pub struct Igloo { /* fields omitted */ }

Igloo should contain a config and any important environment information. Upon running igloo, an instanc is created, env information is stored, and then things happen.

Implementations

impl Igloo

pub fn new() -> Igloo

The new function creates an instance of igloo. The idea is I create an igloo, run start on it so I can collect environment information and process what command the user would like to run, and then I run that command or deal with errors.

This function handles all cli input and stores it. It is parsed for errors in the start function.

pub fn start(&mut self) -> Result<IglooInstType, IglooErrType>

The start function processes the command you want igloo to run It theoretically should never return an error. It should just exit. If an error was returned, It was my fault and not the users. It is really only here to help me debug.

The Inst Type is only returned for usage outside of this struct.

pub fn run(&self, inst_type: IglooInstType) -> Result<String, IglooErrType>

The run function processes the request from the user. On success, it will give some string indicating the success of the operation. On failure, it will return some error type.