Struct EngineTarget 

pub struct EngineTarget { /* private fields */ }

Immutable description of one execution engine, used to prepare a program.

A target names the registered engine kind (engine_id), the concrete engine type (context_identity) and the memory the engine executes on (allocation_domain, None for host memory). It holds no threads, streams or memory. crate::Runtime::prepare places each part of a program on one of the targets it is given, and crate::Runtime::run checks that the engines it receives report the same targets.

Examples

use tenferro_runtime::{EngineId, EngineTarget, ExecutionContextIdentity};

struct ExampleEngine;
let target = EngineTarget::new(
    EngineId::new("example.engine.v1").unwrap(),
    ExecutionContextIdentity::of::<ExampleEngine>(),
    None,
);
assert_eq!(target.engine_id().as_str(), "example.engine.v1");
assert!(target.allocation_domain().is_none());

Implementations

impl EngineTarget

pub fn new( engine_id: EngineId, context_identity: ExecutionContextIdentity, allocation_domain: Option<AllocationDomainId>, ) -> Self

Describe an engine of the registered kind engine_id.

Examples

use tenferro_runtime::{EngineId, EngineTarget, ExecutionContextIdentity};

struct ExampleEngine;
let target = EngineTarget::new(
    EngineId::new("example.engine.v1").unwrap(),
    ExecutionContextIdentity::of::<ExampleEngine>(),
    None,
);
assert_eq!(target.context_identity(), ExecutionContextIdentity::of::<ExampleEngine>());

pub fn engine_id(&self) -> &EngineId

The registered engine kind this target runs as.

Examples

use tenferro_runtime::{EngineId, EngineTarget, ExecutionContextIdentity};
struct E;
let id = EngineId::new("example.engine.v1").unwrap();
let target = EngineTarget::new(id.clone(), ExecutionContextIdentity::of::<E>(), None);
assert_eq!(target.engine_id(), &id);

pub fn context_identity(&self) -> ExecutionContextIdentity

The concrete engine type, checked against the registration.

Examples

use tenferro_runtime::{EngineId, EngineTarget, ExecutionContextIdentity};
struct E;
let target = EngineTarget::new(
    EngineId::new("example.engine.v1").unwrap(),
    ExecutionContextIdentity::of::<E>(),
    None,
);
assert_eq!(target.context_identity(), ExecutionContextIdentity::of::<E>());

pub fn allocation_domain(&self) -> Option<AllocationDomainId>

The memory domain the engine allocates in, None for plain host memory.

Examples

use tenferro_runtime::{EngineId, EngineTarget, ExecutionContextIdentity};
struct E;
let target = EngineTarget::new(
    EngineId::new("example.engine.v1").unwrap(),
    ExecutionContextIdentity::of::<E>(),
    None,
);
assert_eq!(target.allocation_domain(), None);

Trait Implementations

impl Clone for EngineTarget

fn clone(&self) -> EngineTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineTarget

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

Formats the value using the given formatter.

impl Eq for EngineTarget

impl Hash for EngineTarget

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EngineTarget

fn eq(&self, other: &EngineTarget) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EngineTarget