Struct Engine

Source

pub struct Engine {Show 13 fields
    pub file: String,
    pub spec: String,
    pub device: Device,
    pub iiixs: Vec<Iiix>,
    pub params: Option<usize>,
    pub wbmems: Option<usize>,
    pub inputs_minoptmax: Vec<Vec<MinOptMax>>,
    pub onnx: Option<OnnxIo>,
    pub num_dry_run: usize,
    pub graph_opt_level: Option<u8>,
    pub num_intra_threads: Option<usize>,
    pub num_inter_threads: Option<usize>,
    pub hardware: HardwareConfig,
}

Expand description

ONNX Runtime inference engine with configuration and session management.

Fields§

§file: String

Model file path.

§spec: String

Model specification string.

§device: Device

Execution device.

§iiixs: Vec<Iiix>§params: Option<usize>§wbmems: Option<usize>§inputs_minoptmax: Vec<Vec<MinOptMax>>

Input min-opt-max configurations.

§onnx: Option<OnnxIo>

ONNX I/O structure.

§num_dry_run: usize

Number of dry runs for warmup.

§graph_opt_level: Option<u8>§num_intra_threads: Option<usize>§num_inter_threads: Option<usize>§hardware: HardwareConfig

Hardware-specific configurations for all execution providers

Implementations§

Source §

impl Engine

Source

pub fn with_file(self, x: &str) -> Self

Sets the file field from a string slice.

§Arguments

x - A string slice that will be converted to String

§Returns

Returns Self for method chaining.

§Example

let obj = Engine::default().with_file("value");

Generated by aksr - Builder pattern macro

Source

pub fn file(&self) -> &str

Returns a string slice of the file field.

§Example

let obj = Engine::default();
let value = obj.file();

Generated by aksr - Builder pattern macro

Source

pub fn into_file(self) -> String

Consumes self and returns the file field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns the owned value of type String.

§Example

let obj = Engine::default().with_file(value);
let value = obj.into_file();
// obj is now consumed and cannot be used

Generated by aksr - Builder pattern macro

Source

pub fn take_file(&mut self) -> String
where String: Default,

Takes the file field and replaces it with Default::default().

This method moves the value out and replaces it with the default value, allowing you to continue using the struct.

§Returns

Returns the owned value of type String.

§Note

Requires the field type String to implement Default. Prefer this when you want to keep using the instance.

§Example

let mut obj = Engine::default().with_file(value);
let value = obj.take_file();
// obj.file is now set to Default::default()

Generated by aksr - Builder pattern macro

Source

pub fn with_spec(self, x: &str) -> Self

Sets the spec field from a string slice.

§Arguments

x - A string slice that will be converted to String

§Returns

Returns Self for method chaining.

§Example

let obj = Engine::default().with_spec("value");

Generated by aksr - Builder pattern macro

Source

pub fn spec(&self) -> &str

Returns a string slice of the spec field.

§Example

let obj = Engine::default();
let value = obj.spec();

Generated by aksr - Builder pattern macro

Source

pub fn into_spec(self) -> String

Consumes self and returns the spec field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns the owned value of type String.

§Example

let obj = Engine::default().with_spec(value);
let value = obj.into_spec();
// obj is now consumed and cannot be used

Generated by aksr - Builder pattern macro

Source

pub fn take_spec(&mut self) -> String
where String: Default,

Takes the spec field and replaces it with Default::default().

This method moves the value out and replaces it with the default value, allowing you to continue using the struct.

§Returns

Returns the owned value of type String.

§Note

Requires the field type String to implement Default. Prefer this when you want to keep using the instance.

§Example

let mut obj = Engine::default().with_spec(value);
let value = obj.take_spec();
// obj.spec is now set to Default::default()

Generated by aksr - Builder pattern macro

Source

pub fn with_device(self, x: Device) -> Self

Sets the device field.

§Arguments

x - The new value to be assigned

§Returns

Returns Self for method chaining.

§Example

let obj = Engine::default().with_device(value);

Generated by aksr - Builder pattern macro

Source

pub fn device(&self) -> &Device

Returns a reference to the device field.

§Example

let obj = Engine::default();
let value = obj.device();

Generated by aksr - Builder pattern macro

Source

pub fn into_device(self) -> Device

Consumes self and returns the device field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns the owned value of type Device.

§Example

let obj = Engine::default().with_device(value);
let value = obj.into_device();
// obj is now consumed and cannot be used

Generated by aksr - Builder pattern macro

Source

pub fn with_iiixs(self, x: &[Iiix]) -> Self

Sets the iiixs field from a slice.

§Arguments

x - A slice of elements to be converted into a vector

§Returns

Returns Self for method chaining.

§Note

If the slice is empty, the field remains unchanged.

§Example

let obj = Engine::default().with_iiixs(&[item1, item2]);

Generated by aksr - Builder pattern macro

Source

pub fn with_iiixs_extend(self, x: &[Iiix]) -> Self

Appends elements to the iiixs field.

§Arguments

x - A slice of elements to append to the vector

§Returns

Returns Self for method chaining.

§Example

let obj = Engine::default().with_iiixs_extend(&[item1, item2]);

Generated by aksr - Builder pattern macro

Source

pub fn iiixs(&self) -> &[Iiix]

Returns a slice view of the iiixs field.

§Example

let obj = Engine::default();
let items = obj.iiixs();

Generated by aksr - Builder pattern macro

Source

pub fn into_iiixs(self) -> Vec<Iiix>

Consumes self and returns the iiixs field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns the owned value of type Vec < Iiix >.

§Example

let obj = Engine::default().with_iiixs(value);
let value = obj.into_iiixs();
// obj is now consumed and cannot be used

Generated by aksr - Builder pattern macro

Source

pub fn take_iiixs(&mut self) -> Vec<Iiix>
where Vec<Iiix>: Default,

Takes the iiixs field and replaces it with Default::default().

This method moves the value out and replaces it with the default value, allowing you to continue using the struct.

§Returns

Returns the owned value of type Vec < Iiix >.

§Note

Requires the field type Vec < Iiix > to implement Default. Prefer this when you want to keep using the instance.

§Example

let mut obj = Engine::default().with_iiixs(value);
let value = obj.take_iiixs();
// obj.iiixs is now set to Default::default()

Generated by aksr - Builder pattern macro

Source

pub fn with_parameters(self, x: usize) -> Self

Sets the optional params field.

§Arguments

x - The value that will be automatically wrapped in Some

§Returns

Returns Self for method chaining.

§Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

§Example

let obj = Engine::default().with_parameters(value);

Generated by aksr - Builder pattern macro

Source

pub fn parameters(&self) -> Option<usize>

Returns the value of the optional params field.

§Example

let obj = Engine::default();
let value = obj.parameters();

Generated by aksr - Builder pattern macro

Source

pub fn into_parameters(self) -> Option<usize>

Consumes self and returns the params field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns Option containing the field value, or None if the field was None.

§Example

let obj = Engine::default().with_parameters(value);
let value = obj.into_parameters();

Generated by aksr - Builder pattern macro

Source

pub fn take_parameters(&mut self) -> Option<usize>

Takes the params field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

§Returns

Returns Option containing the field value, or None if the field was None.

§Note

This does not require the inner type to implement Default.

§Example

let mut obj = Engine::default().with_parameters(value);
let value = obj.take_parameters();
// obj.params is now None

Generated by aksr - Builder pattern macro

Source

pub fn with_memory(self, x: usize) -> Self

Sets the optional wbmems field.

§Arguments

x - The value that will be automatically wrapped in Some

§Returns

Returns Self for method chaining.

§Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

§Example

let obj = Engine::default().with_memory(value);

Generated by aksr - Builder pattern macro

Source

pub fn memory(&self) -> Option<usize>

Returns the value of the optional wbmems field.

§Example

let obj = Engine::default();
let value = obj.memory();

Generated by aksr - Builder pattern macro

Source

pub fn into_memory(self) -> Option<usize>

Consumes self and returns the wbmems field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns Option containing the field value, or None if the field was None.

§Example

let obj = Engine::default().with_memory(value);
let value = obj.into_memory();

Generated by aksr - Builder pattern macro

Source

pub fn take_memory(&mut self) -> Option<usize>

Takes the wbmems field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

§Returns

Returns Option containing the field value, or None if the field was None.

§Note

This does not require the inner type to implement Default.

§Example

let mut obj = Engine::default().with_memory(value);
let value = obj.take_memory();
// obj.wbmems is now None

Generated by aksr - Builder pattern macro

Source

pub fn with_inputs_minoptmax(self, x: &[Vec<MinOptMax>]) -> Self

Sets the inputs_minoptmax field from a slice.

§Arguments

x - A slice of elements to be converted into a vector

§Returns

Returns Self for method chaining.

§Note

If the slice is empty, the field remains unchanged.

§Example

let obj = Engine::default().with_inputs_minoptmax(&[item1, item2]);

Generated by aksr - Builder pattern macro

Source

pub fn inputs_minoptmax(&self) -> &[Vec<MinOptMax>]

Returns a slice view of the inputs_minoptmax field.

§Example

let obj = Engine::default();
let items = obj.inputs_minoptmax();

Generated by aksr - Builder pattern macro

Source

pub fn into_inputs_minoptmax(self) -> Vec<Vec<MinOptMax>>

Consumes self and returns the inputs_minoptmax field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns the owned value of type Vec < Vec < MinOptMax > >.

§Example

let obj = Engine::default().with_inputs_minoptmax(value);
let value = obj.into_inputs_minoptmax();
// obj is now consumed and cannot be used

Generated by aksr - Builder pattern macro

Source

pub fn take_inputs_minoptmax(&mut self) -> Vec<Vec<MinOptMax>>
where Vec<Vec<MinOptMax>>: Default,

Takes the inputs_minoptmax field and replaces it with Default::default().

This method moves the value out and replaces it with the default value, allowing you to continue using the struct.

§Returns

Returns the owned value of type Vec < Vec < MinOptMax > >.

§Note

Requires the field type Vec < Vec < MinOptMax > > to implement Default. Prefer this when you want to keep using the instance.

§Example

let mut obj = Engine::default().with_inputs_minoptmax(value);
let value = obj.take_inputs_minoptmax();
// obj.inputs_minoptmax is now set to Default::default()

Generated by aksr - Builder pattern macro

Source

pub fn with_onnx(self, x: OnnxIo) -> Self

Sets the optional onnx field.

§Arguments

x - The value that will be automatically wrapped in Some

§Returns

Returns Self for method chaining.

§Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

§Example

let obj = Engine::default().with_onnx(value);

Generated by aksr - Builder pattern macro

Source

pub fn onnx(&self) -> Option<&OnnxIo>

Returns an optional reference to the onnx field.

§Example

let obj = Engine::default();
let value = obj.onnx();

Generated by aksr - Builder pattern macro

Source

pub fn into_onnx(self) -> Option<OnnxIo>

Consumes self and returns the onnx field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns Option containing the field value, or None if the field was None.

§Example

let obj = Engine::default().with_onnx(value);
let value = obj.into_onnx();

Generated by aksr - Builder pattern macro

Source

pub fn take_onnx(&mut self) -> Option<OnnxIo>

Takes the onnx field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

§Returns

Returns Option containing the field value, or None if the field was None.

§Note

This does not require the inner type to implement Default.

§Example

let mut obj = Engine::default().with_onnx(value);
let value = obj.take_onnx();
// obj.onnx is now None

Generated by aksr - Builder pattern macro

Source

pub fn with_num_dry_run(self, x: usize) -> Self

Sets the num_dry_run field.

§Arguments

x - The new value to be assigned

§Returns

Returns Self for method chaining.

§Example

let obj = Engine::default().with_num_dry_run(value);

Generated by aksr - Builder pattern macro

Source

pub fn num_dry_run(&self) -> usize

Returns the value of the num_dry_run field.

§Example

let obj = Engine::default();
let value = obj.num_dry_run();

Generated by aksr - Builder pattern macro

Source

pub fn with_graph_opt_level(self, x: u8) -> Self

Sets the optional graph_opt_level field.

§Arguments

x - The value that will be automatically wrapped in Some

§Returns

Returns Self for method chaining.

§Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

§Example

let obj = Engine::default().with_graph_opt_level(value);

Generated by aksr - Builder pattern macro

Source

pub fn graph_opt_level(&self) -> Option<u8>

Returns the value of the optional graph_opt_level field.

§Example

let obj = Engine::default();
let value = obj.graph_opt_level();

Generated by aksr - Builder pattern macro

Source

pub fn into_graph_opt_level(self) -> Option<u8>

Consumes self and returns the graph_opt_level field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns Option containing the field value, or None if the field was None.

§Example

let obj = Engine::default().with_graph_opt_level(value);
let value = obj.into_graph_opt_level();

Generated by aksr - Builder pattern macro

Source

pub fn take_graph_opt_level(&mut self) -> Option<u8>

Takes the graph_opt_level field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

§Returns

Returns Option containing the field value, or None if the field was None.

§Note

This does not require the inner type to implement Default.

§Example

let mut obj = Engine::default().with_graph_opt_level(value);
let value = obj.take_graph_opt_level();
// obj.graph_opt_level is now None

Generated by aksr - Builder pattern macro

Source

pub fn with_num_intra_threads(self, x: usize) -> Self

Sets the optional num_intra_threads field.

§Arguments

x - The value that will be automatically wrapped in Some

§Returns

Returns Self for method chaining.

§Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

§Example

let obj = Engine::default().with_num_intra_threads(value);

Generated by aksr - Builder pattern macro

Source

pub fn num_intra_threads(&self) -> Option<usize>

Returns the value of the optional num_intra_threads field.

§Example

let obj = Engine::default();
let value = obj.num_intra_threads();

Generated by aksr - Builder pattern macro

Source

pub fn into_num_intra_threads(self) -> Option<usize>

Consumes self and returns the num_intra_threads field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns Option containing the field value, or None if the field was None.

§Example

let obj = Engine::default().with_num_intra_threads(value);
let value = obj.into_num_intra_threads();

Generated by aksr - Builder pattern macro

Source

pub fn take_num_intra_threads(&mut self) -> Option<usize>

Takes the num_intra_threads field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

§Returns

Returns Option containing the field value, or None if the field was None.

§Note

This does not require the inner type to implement Default.

§Example

let mut obj = Engine::default().with_num_intra_threads(value);
let value = obj.take_num_intra_threads();
// obj.num_intra_threads is now None

Generated by aksr - Builder pattern macro

Source

pub fn with_num_inter_threads(self, x: usize) -> Self

Sets the optional num_inter_threads field.

§Arguments

x - The value that will be automatically wrapped in Some

§Returns

Returns Self for method chaining.

§Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

§Example

let obj = Engine::default().with_num_inter_threads(value);

Generated by aksr - Builder pattern macro

Source

pub fn num_inter_threads(&self) -> Option<usize>

Returns the value of the optional num_inter_threads field.

§Example

let obj = Engine::default();
let value = obj.num_inter_threads();

Generated by aksr - Builder pattern macro

Source

pub fn into_num_inter_threads(self) -> Option<usize>

Consumes self and returns the num_inter_threads field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns Option containing the field value, or None if the field was None.

§Example

let obj = Engine::default().with_num_inter_threads(value);
let value = obj.into_num_inter_threads();

Generated by aksr - Builder pattern macro

Source

pub fn take_num_inter_threads(&mut self) -> Option<usize>

Takes the num_inter_threads field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

§Returns

Returns Option containing the field value, or None if the field was None.

§Note

This does not require the inner type to implement Default.

§Example

let mut obj = Engine::default().with_num_inter_threads(value);
let value = obj.take_num_inter_threads();
// obj.num_inter_threads is now None

Generated by aksr - Builder pattern macro

Source

pub fn with_hardware(self, x: HardwareConfig) -> Self

Sets the hardware field.

§Arguments

x - The new value to be assigned

§Returns

Returns Self for method chaining.

§Example

let obj = Engine::default().with_hardware(value);

Generated by aksr - Builder pattern macro

Source

pub fn hardware(&self) -> &HardwareConfig

Returns a reference to the hardware field.

§Example

let obj = Engine::default();
let value = obj.hardware();

Generated by aksr - Builder pattern macro

Source

pub fn into_hardware(self) -> HardwareConfig

Consumes self and returns the hardware field.

This method moves the owned value out of the struct without cloning.

§Returns

Returns the owned value of type HardwareConfig.

§Example

let obj = Engine::default().with_hardware(value);
let value = obj.into_hardware();
// obj is now consumed and cannot be used

Generated by aksr - Builder pattern macro

Source §

pub fn info(&self)

Trait Implementations§

Source §

impl Debug for Engine

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Engine

Source §

fn default() -> Self

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

Auto Trait Implementations§

§

impl Freeze for Engine

§

impl !RefUnwindSafe for Engine

§

impl Send for Engine

§

impl Sync for Engine

§

impl Unpin for Engine

§

impl !UnwindSafe for Engine

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> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §