Struct Plugin

pub struct Plugin { /* private fields */ }

Implementations

impl Plugin

pub fn new(game_id: GameId, filepath: &Path) -> Plugin

pub fn parse_reader<R: Read + Seek>( &mut self, reader: R, options: ParseOptions, ) -> Result<(), Error>

pub fn parse_file(&mut self, options: ParseOptions) -> Result<(), Error>

pub fn resolve_record_ids( &mut self, plugins_metadata: &[PluginMetadata], ) -> Result<(), Error>

plugins_metadata can be empty for all games other than Starfield, and for Starfield plugins with no masters.

pub fn game_id(&self) -> GameId

pub fn path(&self) -> &Path

pub fn filename(&self) -> Option<String>

pub fn masters(&self) -> Result<Vec<String>, Error>

pub fn is_master_file(&self) -> bool

pub fn is_light_plugin(&self) -> bool

pub fn is_medium_plugin(&self) -> bool

pub fn is_update_plugin(&self) -> bool

pub fn is_blueprint_plugin(&self) -> bool

pub fn is_valid(game_id: GameId, filepath: &Path, options: ParseOptions) -> bool

pub fn description(&self) -> Result<Option<String>, Error>

pub fn header_version(&self) -> Option<f32>

pub fn record_and_group_count(&self) -> Option<u32>

pub fn count_override_records(&self) -> Result<usize, Error>

This needs records to be resolved first if run for Morrowind or Starfield.

pub fn overlaps_with(&self, other: &Self) -> Result<bool, Error>

pub fn overlap_size(&self, others: &[&Self]) -> Result<usize, Error>

Count the number of records that appear in this plugin and one or more the others passed. If more than one other contains the same record, it is only counted once.

pub fn is_valid_as_light_plugin(&self) -> Result<bool, Error>

pub fn is_valid_as_medium_plugin(&self) -> Result<bool, Error>

pub fn is_valid_as_update_plugin(&self) -> Result<bool, Error>

Trait Implementations

impl Clone for Plugin

fn clone(&self) -> Plugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plugin

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

Formats the value using the given formatter.

impl Hash for Plugin

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Plugin

fn eq(&self, other: &Plugin) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Plugin

impl StructuralPartialEq for Plugin