Skip to main content

ArcSupplier

Struct ArcSupplier 

Source
pub struct ArcSupplier<T> { /* private fields */ }
Expand description

Thread-safe shared ownership read-only supplier.

Uses Arc<dyn Fn() -> T + Send + Sync> for thread-safe shared ownership. Lock-free - no Mutex needed! Can be cloned and sent across threads with excellent concurrent performance.

§Ownership Model

Methods borrow &self instead of consuming self. The original supplier remains usable after method calls:

use qubit_function::{ArcSupplier, Supplier};

let source = ArcSupplier::new(|| 10);
let mapped = source.map(|x| x * 2);
// source is still usable here!

§Lock-Free Performance

Unlike ArcSupplier, this implementation doesn’t need Mutex. Multiple threads can call get() concurrently without lock contention, making it ideal for high-concurrency scenarios.

§Examples

§Thread-safe Factory

use qubit_function::{ArcSupplier, Supplier};
use std::thread;

let factory = ArcSupplier::new(|| {
    String::from("Hello")
});

let f1 = factory.clone();
let f2 = factory.clone();

let h1 = thread::spawn(move || f1.get());
let h2 = thread::spawn(move || f2.get());

assert_eq!(h1.join().unwrap(), "Hello");
assert_eq!(h2.join().unwrap(), "Hello");

§Reusable Transformations

use qubit_function::{ArcSupplier, Supplier};

let base = ArcSupplier::new(|| 10);
let doubled = base.map(|x| x * 2);
let tripled = base.map(|x| x * 3);

// All remain usable
assert_eq!(base.get(), 10);
assert_eq!(doubled.get(), 20);
assert_eq!(tripled.get(), 30);

§Author

Haixing Hu

Implementations§

Source§

impl<T> ArcSupplier<T>

Source

pub fn new<F>(f: F) -> Self
where F: Fn() -> T + Send + Sync + 'static,

Creates a new supplier.

Wraps the provided closure in the appropriate smart pointer type for this supplier implementation.

Source

pub fn new_with_name<F>(name: &str, f: F) -> Self
where F: Fn() -> T + Send + Sync + 'static,

Creates a new named supplier.

Wraps the provided closure and assigns it a name, which is useful for debugging and logging purposes.

Source

pub fn new_with_optional_name<F>(f: F, name: Option<String>) -> Self
where F: Fn() -> T + Send + Sync + 'static,

Creates a new named supplier with an optional name.

Wraps the provided closure and assigns it an optional name.

Source

pub fn name(&self) -> Option<&str>

Gets the name of this supplier.

§Returns

Returns Some(&str) if a name was set, None otherwise.

Source

pub fn set_name(&mut self, name: &str)

Sets the name of this supplier.

§Parameters
  • name - The name to set for this supplier
Source

pub fn map<U, M>(&self, mapper: M) -> ArcSupplier<U>
where T: 'static, M: Transformer<T, U> + Send + Sync + 'static, U: 'static,

Maps the output using a transformation function.

§Parameters
  • mapper - The transformation function to apply
§Returns

A new $struct_name<U> with the mapped output

§Examples
use qubit_function::{$struct_name, $supplier_trait};

let source = $struct_name::new(|| 10);
let mapped = source.map(|x| x * 2);
// source is still usable
assert_eq!(mapped.get(), 20);
Source

pub fn filter<P>(&self, predicate: P) -> ArcSupplier<Option<T>>
where T: 'static, P: Predicate<T> + Send + Sync + 'static,

Filters output based on a predicate.

§Parameters
  • predicate - The predicate to test the supplied value
§Returns

A new filtered $struct_name<Option<$t>>

§Examples
use qubit_function::{$struct_name, $supplier_trait};

let source = $struct_name::new(|| 42);
let filtered = source.filter(|x| x % 2 == 0);

assert_eq!(filtered.get(), Some(42));
Source

pub fn zip<U, S>(&self, other: S) -> ArcSupplier<(T, U)>
where T: 'static, S: Supplier<U> + Send + Sync + 'static, U: 'static,

Combines this supplier with another, producing a tuple.

§Parameters
  • other - The other supplier to combine with
§Returns

A new $struct_name<($t, U)>

§Examples
use qubit_function::{$struct_name, $supplier_trait};

let first = $struct_name::new(|| 42);
let second = $struct_name::new(|| "hello");

let zipped = first.zip(second);

assert_eq!(zipped.get(), (42, "hello"));
Source§

impl<T> ArcSupplier<T>

Source

pub fn constant(value: T) -> Self
where T: Clone + Send + Sync + 'static,

Creates a supplier that returns a constant value.

Creates a supplier that always returns the same value. Useful for default values or placeholder implementations.

Note: This method requires T: Sync because the constant value is captured by a Fn closure which needs to be Sync for Arc.

§Parameters
  • value - The constant value to return
§Returns

Returns a new supplier instance that returns the constant value.

§Examples
use qubit_function::{ArcSupplier, Supplier};

let supplier = ArcSupplier::constant(42);
assert_eq!(supplier.get(), 42);
assert_eq!(supplier.get(), 42); // Can be called multiple times

Trait Implementations§

Source§

impl<T> Clone for ArcSupplier<T>

Source§

fn clone(&self) -> Self

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<T> Debug for ArcSupplier<T>

Source§

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

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

impl<T> Display for ArcSupplier<T>

Source§

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

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

impl<T> Supplier<T> for ArcSupplier<T>

Source§

fn get(&self) -> T

Generates and returns a value. Read more
Source§

fn into_box(self) -> BoxSupplier<T>
where T: 'static,

Converts to BoxSupplier. Read more
Source§

fn into_rc(self) -> RcSupplier<T>
where T: 'static,

Converts to RcSupplier. Read more
Source§

fn into_arc(self) -> ArcSupplier<T>

Converts to ArcSupplier. Read more
Source§

fn into_fn(self) -> impl Fn() -> T

Converts to a closure implementing Fn() -> T. Read more
Source§

fn into_once(self) -> BoxSupplierOnce<T>
where T: 'static,

Converts to BoxSupplierOnce. Read more
Source§

fn to_box(&self) -> BoxSupplier<T>
where T: 'static,

Converts to BoxSupplier by cloning. Read more
Source§

fn to_rc(&self) -> RcSupplier<T>
where T: 'static,

Converts to RcSupplier by cloning. Read more
Source§

fn to_arc(&self) -> ArcSupplier<T>

Converts to ArcSupplier by cloning. Read more
Source§

fn to_fn(&self) -> impl Fn() -> T

Converts to a closure by cloning. Read more
Source§

fn to_once(&self) -> BoxSupplierOnce<T>
where T: 'static,

Converts to BoxSupplierOnce without consuming self Read more

Auto Trait Implementations§

§

impl<T> Freeze for ArcSupplier<T>

§

impl<T> !RefUnwindSafe for ArcSupplier<T>

§

impl<T> Send for ArcSupplier<T>

§

impl<T> Sync for ArcSupplier<T>

§

impl<T> Unpin for ArcSupplier<T>

§

impl<T> UnsafeUnpin for ArcSupplier<T>

§

impl<T> !UnwindSafe for ArcSupplier<T>

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.