Skip to main content

AtomicValue

Struct AtomicValue 

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

A concurrent-safe single value container using arc-swap.

This container provides atomic load and store operations for a single value. It’s ideal for configuration values or shared state that needs to be read frequently and updated occasionally.

§Type Parameters

  • T - The value type

§Example

use litellm_rs::utils::sync::AtomicValue;

let value: AtomicValue<String> = AtomicValue::new("initial".to_string());
assert_eq!(value.load().as_ref(), "initial");

value.store("updated".to_string());
assert_eq!(value.load().as_ref(), "updated");

Implementations§

Source§

impl<T> AtomicValue<T>

Source

pub fn new(value: T) -> Self

Creates a new AtomicValue with the specified initial value.

§Arguments
  • value - The initial value
§Example
use litellm_rs::utils::sync::AtomicValue;

let value: AtomicValue<i32> = AtomicValue::new(42);
Source

pub fn load(&self) -> Arc<T> ⓘ

Loads the current value.

Returns an Arc pointing to the current value. This is a very fast operation and does not block other readers or writers.

§Returns

An Arc<T> containing the current value.

§Example
use litellm_rs::utils::sync::AtomicValue;

let value: AtomicValue<i32> = AtomicValue::new(42);
let current = value.load();
assert_eq!(*current, 42);
Source

pub fn store(&self, value: T)

Stores a new value, replacing the current one.

This operation is atomic and will not block readers.

§Arguments
  • value - The new value to store
§Example
use litellm_rs::utils::sync::AtomicValue;

let value: AtomicValue<i32> = AtomicValue::new(42);
value.store(100);
assert_eq!(*value.load(), 100);
Source

pub fn swap(&self, value: T) -> Arc<T> ⓘ

Swaps the current value with a new one, returning the old value.

§Arguments
  • value - The new value to store
§Returns

An Arc<T> containing the previous value.

§Example
use litellm_rs::utils::sync::AtomicValue;

let value: AtomicValue<i32> = AtomicValue::new(42);
let old = value.swap(100);
assert_eq!(*old, 42);
assert_eq!(*value.load(), 100);
Source

pub fn store_arc(&self, value: Arc<T>)

Stores a new value from an Arc.

This is useful when you already have an Arc and want to avoid an extra allocation.

§Arguments
  • value - An Arc containing the new value
§Example
use litellm_rs::utils::sync::AtomicValue;
use std::sync::Arc;

let value: AtomicValue<i32> = AtomicValue::new(42);
value.store_arc(Arc::new(100));
assert_eq!(*value.load(), 100);
Source

pub fn swap_arc(&self, value: Arc<T>) -> Arc<T> ⓘ

Swaps the current value with a new Arc, returning the old value.

§Arguments
  • value - An Arc containing the new value
§Returns

An Arc<T> containing the previous value.

§Example
use litellm_rs::utils::sync::AtomicValue;
use std::sync::Arc;

let value: AtomicValue<i32> = AtomicValue::new(42);
let old = value.swap_arc(Arc::new(100));
assert_eq!(*old, 42);
Source§

impl<T: Clone> AtomicValue<T>

Source

pub fn update<F>(&self, f: F) -> T
where F: Fn(&T) -> T,

Updates the value using a closure, with atomic compare-and-swap retry.

This operation uses ArcSwap::rcu() to perform a read-copy-update loop, retrying until the compare-and-swap succeeds. The closure may be called more than once if concurrent updates occur, so it must be side-effect-free (i.e., Fn rather than FnOnce).

§Arguments
  • f - A closure that takes a reference to the current value and returns the new value
§Returns

The new value after the update.

§Example
use litellm_rs::utils::sync::AtomicValue;

let value: AtomicValue<i32> = AtomicValue::new(42);
let new_value = value.update(|v| v + 1);
assert_eq!(new_value, 43);
Source

pub fn get(&self) -> T

Gets a clone of the current value.

This is a convenience method that loads the value and clones it.

§Returns

A clone of the current value.

§Example
use litellm_rs::utils::sync::AtomicValue;

let value: AtomicValue<String> = AtomicValue::new("hello".to_string());
let cloned: String = value.get();
assert_eq!(cloned, "hello");

Trait Implementations§

Source§

impl<T> Clone for AtomicValue<T>

Source§

fn clone(&self) -> Self

Creates a new AtomicValue pointing to the same underlying data.

Note: This creates a new AtomicValue that shares the same Arc, but updates to one will not affect the other after the clone.

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for AtomicValue<T>

Source§

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

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

impl<T: Default> Default for AtomicValue<T>

Source§

fn default() -> Self

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

impl<T> From<Arc<T>> for AtomicValue<T>

Source§

fn from(value: Arc<T>) -> Self

Converts to this type from the input type.
Source§

impl<T> From<T> for AtomicValue<T>

Source§

fn from(value: T) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> !Freeze for AtomicValue<T>

§

impl<T> RefUnwindSafe for AtomicValue<T>

§

impl<T> Send for AtomicValue<T>
where ArcSwapAny<Arc<T>>: Send,

§

impl<T> Sync for AtomicValue<T>
where ArcSwapAny<Arc<T>>: Sync,

§

impl<T> Unpin for AtomicValue<T>
where ArcSwapAny<Arc<T>>: Unpin,

§

impl<T> UnsafeUnpin for AtomicValue<T>

§

impl<T> UnwindSafe for AtomicValue<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> BudgetAwareRouting for T

Source§

fn filter_by_budget( &self, providers: Vec<String>, budget_router: &BudgetAwareRouter, ) -> Vec<String>

Filter providers based on budget availability
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> 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<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> 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§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SharedResource for T
where T: Send + Sync + 'static,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more