Struct seaplane_cli::ops::formation::Formations

pub struct Formations {
    pub formations: Vec<Formation>,
    pub configurations: Vec<FormationConfiguration>,
    /* private fields */
}

This struct represents a Local Formation. I.e. one the user can interact with on the CLI and can be (de)serialized locally.

A somewhat counter-intuitive thing about “Formations” and their models is the there is no “Formation Model” only a “Formation Configuration Model” This is because a “Formation” so to speak is really just a named collection of configurations and info about their traffic weights/activation statuses.

Fields

formations: Vec<Formation>

A list of “Formation“s

configurations: Vec<FormationConfiguration>

A list of “Formation Configuration“s

We keep these separate from the Formation themselves because multiple formations can reference the same configuration.

Implementations

impl Formations

pub fn get_configuration_by_uuid(
    &self,
    uuid: Uuid
) -> Option<&FormationConfiguration>

pub fn remote_names(&self) -> Vec<&str>

pub fn has_flight(&self, flight: &str) -> bool

pub fn formations(&self) -> impl Iterator<Item = &Formation>

pub fn configurations(&self) -> impl Iterator<Item = &FormationConfiguration>

pub fn get_configuration(&self, id: &Id) -> Option<&FormationConfiguration>

pub fn remove_configuration(&mut self, id: &Id) -> Option<FormationConfiguration>

Returns the removed FormationConfiguration by ID or None if there was no match

DANGER: this will invalidate any previously held indices after the removed item

pub fn get_formation(&self, idx: usize) -> Option<&Formation>

pub fn get_formation_mut(&mut self, idx: usize) -> Option<&mut Formation>

pub fn update_or_create_configuration(
    &mut self,
    cfg: FormationConfiguration
) -> Option<Id>

Either updates a matching local Formation Configurations, or creates a new one. Returns the existing ID of the config that was updated if any

pub fn update_or_create_formation(&mut self, formation: Formation) -> Option<Id>

Either updates a matching local Formations by replacing the local IDs, or creates a new one. Returns NEW Formations IDs

pub fn add_uuid(&mut self, id: &Id, uuid: Uuid)

pub fn add_in_air_by_name(&mut self, name: &str, id: Id)

pub fn add_grounded_by_name(&mut self, name: &str, id: Id)

pub fn contains_name(&self, name: &str) -> bool

Returns true if there is a Formation with the given name

pub fn remove_name(&mut self, name: &str) -> Option<Formation>

Removes an exact name match, returning the removed Formation or None if nothing matched.

DANGER: this will invalidate any previously held indices after the removed item

pub fn formation_index_of_name(&self, name: &str) -> Option<usize>

Returns the index of an exact name match

pub fn configuration_index_of_id(&self, id: &Id) -> Option<usize>

pub fn formation_indices_of_matches(&self, name: &str) -> Vec<usize>

Returns all indices of an exact name or partial ID match

pub fn formation_indices_of_left_matches(&self, name: &str) -> Vec<usize>

Returns all indices of a partial name or ID match

pub fn remove_formation_indices(&mut self, indices: &[usize]) -> Vec<Formation>

Removes all indices

pub fn remove_flight(&mut self, flight: &str)

Removes the given flight from all formations that reference it

Trait Implementations

impl Clone for Formations

fn clone(&self) -> Formations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Formations

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

Formats the value using the given formatter.

impl Default for Formations

fn default() -> Formations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Formations

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

Deserialize this value from the given Serde deserializer.

impl FromDisk for Formations

fn set_loaded_from<P: AsRef<Path>>(&mut self, p: P)

Allows one to save or deserialize what path the item was loaded from

fn loaded_from(&self) -> Option<&Path>

If saved, get the path the item was loaded from

fn load_if<P: AsRef<Path>>(p: P, yes: bool) -> Option<Result<Self>>where
    Self: Sized + DeserializeOwned,

Only load from disk if yes is true, otherwise return None

fn load<P: AsRef<Path>>(p: P) -> Result<Self>where
    Self: Sized + DeserializeOwned,

Deserialize from some given path

impl Output for Formations

fn print_json(&self, _ctx: &Ctx) -> Result<()>

fn print_table(&self, _ctx: &Ctx) -> Result<()>

impl Serialize for Formations

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

Serialize this value into the given Serde serializer.

impl ToDisk for Formations

fn persist_if(&self, yes: bool) -> Result<()>where
    Self: Sized + Serialize,

Persist to path only if yes is true

fn persist(&self) -> Result<()>where
    Self: Sized + Serialize,

Serializes itself to the given path