Struct fahapi::API

pub struct API {
    pub conn: Connection,
    pub buf: Vec<u8>,
}

Wrapper for the FAH API. Use API::connect_timeout() to initialize.

Example

fn example() -> fahapi::Result<()> {
    let mut api = fahapi::API::connect_timeout(&fahapi::DEFAULT_ADDR, std::time::Duration::from_secs(1))?;
    api.pause_all()?;
    api.unpause_all()
}

Fields

conn: Connection

buf: Vec<u8>

Implementations

impl API

pub fn connect_timeout(addr: &SocketAddr, timeout: Duration) -> Result<API>

Connects to your FAH client with a timeout. DEFAULT_ADDR is the default address.

pub fn help(&mut self) -> Result<String>

Returns a listing of the FAH API commands.

pub fn log_updates(&mut self, arg: LogUpdatesArg) -> Result<String>

Enables or disables log updates. Returns current log.

pub fn screensaver(&mut self) -> Result<()>

Unpauses all slots which are paused waiting for a screensaver and pause them again on disconnect.

pub fn always_on(&mut self, slot: i64) -> Result<()>

Sets a slot to be always on.

pub fn configured(&mut self) -> Result<bool>

Returns true if the client has set a user, team or passkey.

pub fn do_cycle(&mut self) -> Result<()>

Runs one client cycle.

pub fn finish_slot(&mut self, slot: i64) -> Result<()>

Pauses a slot when its current work unit is completed.

pub fn finish_all(&mut self) -> Result<()>

Pauses all slots one-by-one when their current work unit is completed.

pub fn info(&mut self) -> Result<Vec<Vec<Value>>>

Returns FAH build and machine info. See info_struct().

pub fn info_struct(&mut self) -> Result<Info>

Converts Info() data into a structure. Consider this interface to be very unstable.

pub fn num_slots(&mut self) -> Result<i64>

Returns the number of slots.

pub fn on_idle(&mut self, slot: i64) -> Result<()>

Sets a slot to run only when idle.

pub fn on_idle_all(&mut self) -> Result<()>

Sets all slots to run only when idle.

pub fn options_get(&mut self) -> Result<Options>

Returns the FAH client options.

pub fn options_set<N>(&mut self, key: &str, value: N) -> Result<()> where
    N: Display, 

Sets an option.

pub fn pause_all(&mut self) -> Result<()>

Pauses all slots.

pub fn pause_slot(&mut self, slot: i64) -> Result<()>

Pauses a slot.

pub fn ppd(&mut self) -> Result<f64>

pub fn queue_info(&mut self) -> Result<Vec<SlotQueueInfo>>

Returns info about the current work unit.

pub fn request_id(&mut self) -> Result<()>

Requests an ID from the assignment server.

pub fn request_ws(&mut self) -> Result<()>

Requests work server assignment from the assignment server.

pub fn shutdown(&mut self) -> Result<()>

Ends all FAH processes.

pub fn simulation_info(&mut self, slot: i64) -> Result<SimulationInfo>

Returns the simulation information for a slot.

pub fn slot_delete(&mut self, slot: i64) -> Result<()>

Deletes a slot.

pub fn slot_info(&mut self) -> Result<Vec<SlotInfo>>

Returns information about each slot.

pub fn slot_options_get(&mut self, slot: i64) -> Result<SlotOptions>

Returns slot options.

pub fn slot_options_set<N>(
    &mut self,
    slot: i64,
    key: &str,
    value: N
) -> Result<()> where
    N: Display, 

Sets slot option.

pub fn unpause_all(&mut self) -> Result<()>

Unpauses all slots.

pub fn unpause_slot(&mut self, slot: i64) -> Result<()>

Unpauses a slot.

pub fn uptime(&mut self) -> Result<FAHDuration>

Returns FAH uptime.

pub fn wait_for_units(&mut self) -> Result<()>

Blocks until all slots are paused.

Trait Implementations

impl Debug for API

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

Formats the value using the given formatter.