Struct NvmlBuilder

pub struct NvmlBuilder<'a> { /* private fields */ }

A builder struct that provides further flexibility in how NVML is initialized.

Examples

Initialize NVML with a non-default name for the shared object file:

use nvml_wrapper::Nvml;
use std::ffi::OsStr;

let init_result = Nvml::builder().lib_path(OsStr::new("libnvidia-ml-other-name.so")).init();

Initialize NVML with a non-default path to the shared object file:

use nvml_wrapper::Nvml;
use std::ffi::OsStr;

let init_result = Nvml::builder().lib_path(OsStr::new("/some/path/to/libnvidia-ml.so")).init();

Implementations

impl<'a> NvmlBuilder<'a>

pub fn lib_path(&mut self, path: &'a OsStr) -> &mut Self

Set the path to the NVML lib file.

See libloading’s docs for details about how this lib path is handled.

pub fn flags(&mut self, flags: InitFlags) -> &mut Self

Set the InitFlags to initialize NVML with.

pub fn init(&self) -> Result<Nvml, NvmlError>

Perform initialization.

Trait Implementations

impl<'a> Clone for NvmlBuilder<'a>

fn clone(&self) -> NvmlBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for NvmlBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for NvmlBuilder<'a>

fn default() -> NvmlBuilder<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for NvmlBuilder<'a>

fn eq(&self, other: &NvmlBuilder<'a>) -> bool

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

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<'a> Eq for NvmlBuilder<'a>

impl<'a> StructuralPartialEq for NvmlBuilder<'a>