Struct PjrtPlugin 

pub struct PjrtPlugin { /* private fields */ }

Dynamically loaded PJRT plugin.

Examples

use tenferro_xla::{Error, PjrtPlugin};

let err = PjrtPlugin::load_from_env("__TENFERRO_XLA_DOCS_UNSET").unwrap_err();
assert!(matches!(err, Error::MissingEnv { .. }));

Implementations

impl PjrtPlugin

pub fn load_from_env(var: &'static str) -> Result<Self>

Load a PJRT plugin path from an environment variable.

Examples

use tenferro_xla::{Error, PjrtPlugin};

let err = PjrtPlugin::load_from_env("__TENFERRO_XLA_DOCS_UNSET").unwrap_err();
assert!(matches!(err, Error::MissingEnv { .. }));

Errors

Returns Error::MissingEnv when var is unset, or Error::PluginLoad with the typed dynamic-library source when loading or symbol lookup fails.

pub fn load_path(path: impl Into<PathBuf>) -> Result<Self>

Load a PJRT plugin from an explicit dynamic-library path.

Examples

use tenferro_xla::{Error, PjrtPlugin};

let err = PjrtPlugin::load_path("/definitely/missing/pjrt.so").unwrap_err();
assert!(matches!(err, Error::PluginLoad { .. }));

Errors

Returns Error::PluginLoad with the original dynamic-library error as its source when the file cannot be opened or GetPjrtApi is missing, or Error::PjrtCall when the plugin returns a null API table.

pub fn path(&self) -> &Path

Return the path used to load the plugin.

Examples

use std::path::Path;
use tenferro_xla::PjrtPlugin;

let _path_type = std::any::type_name::<&Path>();
let _method: fn(&PjrtPlugin) -> &Path = PjrtPlugin::path;

Trait Implementations

impl Debug for PjrtPlugin

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

Formats the value using the given formatter.