Skip to main content

PluginLayout

Struct PluginLayout 

Source
pub struct PluginLayout {
    pub dir: PathBuf,
    pub name: String,
}
Expand description

Where things live inside a Rusteal plugin, Plugins/<Name>/: the plugin and its one C++ module share the name.

Fields§

§dir: PathBuf

The plugin’s directory, holding <Name>.uplugin.

§name: String

The plugin’s name, which is also its C++ module’s.

Implementations§

Source§

impl PluginLayout

Source

pub fn new(dir: &Path) -> Self

Source

pub fn descriptor(&self) -> PathBuf

The plugin’s descriptor.

Source

pub fn config_file(&self) -> PathBuf

The plugin’s rusteal.toml.

Source

pub fn rust_workspace(&self) -> PathBuf

Cargo workspace with the plugin’s crate and its bindings.

Source

pub fn module_dir(&self) -> PathBuf

The plugin’s C++ module.

Source

pub fn binaries(&self, platform: &str) -> PathBuf

The deployed library’s directory: the plugin’s binaries for the platform (Binaries/Linux).

Source

pub fn library_stem(&self) -> String

The stem of the deployed library’s file name (rusteal_<Name>), as RustealRegisterPluginLibrary looks for it.

Source

pub fn output(&self, kind: LibraryKind) -> LibraryOutput

The output of the plugin’s library, of the given kind.

Auto Trait Implementations§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.