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

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§

source§

impl<'a> NvmlBuilder<'a>

source

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.

source

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

Set the InitFlags to initialize NVML with.

source

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

Perform initialization.

Trait Implementations§

source§

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

source§

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

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

source§

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

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

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

source§

fn default() -> NvmlBuilder<'a>

Returns the “default value” for a type. Read more
source§

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

source§

fn eq(&self, other: &NvmlBuilder<'a>) -> 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<'a> Eq for NvmlBuilder<'a>

source§

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

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for NvmlBuilder<'a>

§

impl<'a> Send for NvmlBuilder<'a>

§

impl<'a> Sync for NvmlBuilder<'a>

§

impl<'a> Unpin for NvmlBuilder<'a>

§

impl<'a> UnwindSafe for NvmlBuilder<'a>

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.