Skip to main content

StateBlob

Struct StateBlob 

pub struct StateBlob {
    pub kind: String,
    pub version: u32,
    pub data: Value,
}
Expand description

A typed, versioned piece of state persisted through storage.

This is the replacement for Optuna’s system_attrs junk drawer: sampler and scheduler state is data, not object innards. It is serializable, so it survives a process restart and works across machines; it carries a kind and a version, so a backend can refuse to hand a v1 blob to code expecting v2 instead of deserializing garbage.

use atune_core::storage::StateBlob;
use serde::{Deserialize, Serialize};

#[derive(Debug, PartialEq, Serialize, Deserialize)]
struct RungTable { rungs: Vec<u64> }

let blob = StateBlob::encode("asha", 1, &RungTable { rungs: vec![1, 3, 9] }).unwrap();
assert!(blob.is("asha", 1));
assert_eq!(blob.decode::<RungTable>().unwrap().rungs, vec![1, 3, 9]);

Fields§

§kind: String

What produced the blob ("tpe", "asha", …). Namespaces the payload inside a Scope.

§version: u32

The payload’s schema version, owned by whoever wrote it.

§data: Value

The payload.

Implementations§

§

impl StateBlob

pub fn new(kind: impl Into<String>, version: u32, data: Value) -> Self

Wraps an already-serialized payload.

pub fn encode<T>( kind: impl Into<String>, version: u32, value: &T, ) -> Result<Self>
where T: Serialize + ?Sized,

Serializes value into a blob.

§Errors

Error::Storage if the value cannot be serialized.

pub fn decode<T>(&self) -> Result<T>

Deserializes the payload.

The caller is expected to have checked is first; a blob written by a different producer will usually fail here rather than silently decode.

§Errors

Error::Storage if the payload does not match T.

pub fn is(&self, kind: &str, version: u32) -> bool

true if the blob was written by kind at version.

pub fn ensure_schema_compatible(&self, replacement: &Self) -> Result<()>

Rejects replacing this blob with a different kind or schema version.

Lifecycle backends call this while holding their owner/transaction fence. A typed writer may replace the payload, but it must not replace an incompatible canonical blob and thereby erase data it cannot read.

§Errors

Error::Incompatible if the replacement has a different kind or schema version.

Trait Implementations§

§

impl Clone for StateBlob

§

fn clone(&self) -> StateBlob

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for StateBlob

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for StateBlob

§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl PartialEq for StateBlob

§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl Serialize for StateBlob

§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl StructuralPartialEq for StateBlob

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

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

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