Skip to main content

Factory

Struct Factory 

Source
pub struct Factory { /* private fields */ }
Expand description

How a Factory generates artifacts.

§Examples

use uselesskey_core::{Factory, Mode, Seed};

// Check if a factory is in random or deterministic mode
let fx = Factory::random();
assert!(matches!(fx.mode(), Mode::Random));

let seed = Seed::from_env_value("test").unwrap();
let fx = Factory::deterministic(seed);
assert!(matches!(fx.mode(), Mode::Deterministic { .. }));

Implementations§

Source§

impl Factory

Source

pub fn new(mode: Mode) -> Self

Create a new factory with the specified mode.

Source

pub fn random() -> Self

Create a factory in random mode.

Each process run produces different artifacts, but within a process, artifacts are cached by (domain, label, spec, variant).

Source

pub fn deterministic(master: Seed) -> Self

Create a deterministic factory from an existing seed.

Source

pub fn deterministic_from_str(text: &str) -> Self

Create a deterministic factory from plain text.

This hashes the provided string verbatim with BLAKE3. Unlike Seed::from_env_value, it does not trim whitespace or interpret hex-shaped strings specially.

Source

pub fn deterministic_from_env(var: &str) -> Result<Self, Error>

Create a deterministic factory from an environment variable.

The environment variable can contain:

  • A 64-character hex string (with optional 0x prefix)
  • Any other string (hashed to produce a 32-byte seed)
§Errors

Returns an error if the environment variable is not set.

Source

pub fn mode(&self) -> &Mode

Returns the mode this factory is operating in.

Source

pub fn clear_cache(&self)

Clear the artifact cache.

Source

pub fn get_or_init<T, F>( &self, domain: ArtifactDomain, label: &str, spec_bytes: &[u8], variant: &str, init: F, ) -> Arc<T>
where T: Any + Send + Sync + 'static, F: FnOnce(&mut ChaCha20Rng) -> T,

Get a cached artifact by (domain, label, spec, variant) or generate one.

Trait Implementations§

Source§

impl Clone for Factory

Source§

fn clone(&self) -> Factory

Returns a duplicate 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 Debug for Factory

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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,

Source§

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>,

Source§

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>,

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V