Struct esplugin::Plugin

source ·
pub struct Plugin { /* private fields */ }

Implementations§

source§

impl Plugin

source

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

source

pub fn parse( &mut self, input: &[u8], load_header_only: bool ) -> Result<(), Error>

source

pub fn parse_open_file( &mut self, file: File, load_header_only: bool ) -> Result<(), Error>

source

pub fn parse_file(&mut self, load_header_only: bool) -> Result<(), Error>

source

pub fn game_id(&self) -> &GameId

source

pub fn path(&self) -> &Path

source

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

source

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

source

pub fn is_master_file(&self) -> bool

source

pub fn is_light_master_file(&self) -> bool

👎Deprecated: This has been renamed to Plugin::is_light_plugin() for clarity.
source

pub fn is_light_plugin(&self) -> bool

source

pub fn is_override_plugin(&self) -> bool

source

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

source

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

source

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

source

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

source

pub fn count_override_records(&self) -> usize

source

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

source

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

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.

source

pub fn is_valid_as_light_master(&self) -> bool

👎Deprecated: This has been renamed to Plugin::is_valid_as_light_plugin() for clarity.
source

pub fn is_valid_as_light_plugin(&self) -> bool

source

pub fn is_valid_as_override_plugin(&self) -> bool

Trait Implementations§

source§

impl Clone for Plugin

source§

fn clone(&self) -> Plugin

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Plugin

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Plugin

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Plugin

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Plugin

source§

impl StructuralPartialEq for Plugin

Auto Trait Implementations§

§

impl Freeze for Plugin

§

impl RefUnwindSafe for Plugin

§

impl Send for Plugin

§

impl Sync for Plugin

§

impl Unpin for Plugin

§

impl UnwindSafe for Plugin

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.