Struct ModelSet 

pub struct ModelSet { /* private fields */ }

Models a host offers, each id once, in the order the host lists them.

Implementations

impl ModelSet

pub fn new(build: BuildInfo) -> Self

Returns an empty set that records build as the build of every entry inserted without one.

pub fn insert(&mut self, entry: ModelEntry) -> Result<&mut Self, ModelSetError>

Adds entry. An entry whose source records no build yet receives the set’s build, and any other entry keeps the build it records.

Note that an entry registered from a type in a third-party crate also receives the set’s build. Its source’s type path still refers to the real crate. A model library therefore exports a set built from its own build_info!, and its entries keep its name and version.

Errors

Returns ModelSetError::DuplicateId for an id the set holds, and ModelSetError::InvalidId for an id outside the grammar. The set is unchanged on an error.

pub fn extend(&mut self, other: Self) -> Result<&mut Self, ModelSetError>

Adds every entry of other, each keeping its own source.

Errors

Returns ModelSetError::DuplicateId for an id both sets hold. Checks every id before it adds any, and leaves the set unchanged on an error.

pub fn get(&self, id: &str) -> Option<&ModelEntry>

Returns entry id, whether or not a host can run it.

pub fn lookup( &self, id: &str, gpu: Option<&GpuContext>, ) -> Result<&ModelEntry, ModelLookupError>

Returns entry id, or the reason a host with gpu cannot run it.

Errors

Returns ModelLookupError::NotInSet for an id missing from the set, and ModelLookupError::NeedsGpu for a GPU model when gpu is None.

pub fn runnable<'a>( &'a self, gpu: Option<&GpuContext>, ) -> impl Iterator<Item = &'a ModelEntry> + use<'a>

Returns the entries a host with gpu can run, in the set’s order. A GPU model runs only with a device.

pub fn iter(&self) -> ModelSetIter<'_>

Returns an iterator over the entries, in the set’s order.

pub fn len(&self) -> usize

Number of entries.

pub fn is_empty(&self) -> bool

Returns whether the set holds no entry.

pub fn gpu_needs(&self) -> GpuNeeds

Returns the merged needs of every GPU entry. A host requests a device that meets them before any model builds.

Trait Implementations

impl Clone for ModelSet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelSet

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a ModelSet

type Item = &'a ModelEntry

The type of the elements being iterated over.

type IntoIter = ModelSetIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.