Struct vtflib::VtfLib

#[must_use]
pub struct VtfLib(_);

Represents initialized library. Only one of these can exist at any given time. This struct is !Send + !Sync since the library is not thread-safe.

Implementations

impl VtfLib

#[must_use]

pub fn initialize() -> Option<(Self, VtfGuard)>

Initialize the library. Returns None if it’s already initialized. Uninitialization happens when both returned structs are dropped.

#[must_use]

pub fn get_version() -> u32

Get the library’s version number.

#[must_use]

pub fn get_version_string() -> &'static str

Get the library’s version number string.

#[must_use]

pub fn get_integer(&self, option: IntegerOption) -> i32

Get the value of an integer configuration option.

pub fn set_integer(&self, option: IntegerOption, value: i32)

Set the value of an integer configuration option.

#[must_use]

pub fn get_float(&self, option: FloatOption) -> f32

Get the value of a floating point configuration option.

pub fn set_float(&self, option: FloatOption, value: f32)

Set the value of a floating point configuration option.

pub fn new_vtf_file(&self) -> VtfFile<'_>

Create a vtf file. The VtfFile needs to be bound before it can be worked on.

Panics

Panics if the vtf creation fails. This should not happen.

Trait Implementations

impl Debug for VtfLib

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

Formats the value using the given formatter.

impl Drop for VtfLib

fn drop(&mut self)

Executes the destructor for this type.