Skip to main content

StateStreamConfig

Struct StateStreamConfig 

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

Configuration for one independently sampled logical output stream.

Field names are exact keys from the run’s SystemStateSchema. Their input order is irrelevant: the encoder writes them in canonical template order. Chunk targets are rollover thresholds, while individual-file streams seal every record immediately. The queue byte limit is strict in either layout.

Implementations§

Source§

impl StateStreamConfig

Source

pub fn new<I, K>( name: impl Into<String>, fields: I, sampling_interval: SamplingInterval, storage: Option<StateStreamStorage>, ) -> Self
where I: IntoIterator<Item = K>, K: Into<String>,

Creates a stream whose relative output directory initially equals its logical name.

storage == None inherits writer-wide storage. Non-zero types make explicit limits valid by construction. Names, paths, duplicate fields, and state-key membership are validated together by SystemStateWriterBuilder::create_new_recording.

Source

pub fn with_relative_directory(self, directory: impl Into<String>) -> Self

Overrides the stream’s relative directory beneath the run root.

Absolute paths, empty paths, and . or .. components are rejected at start. Distinct streams must use distinct directories.

Source

pub fn name(&self) -> &str

Returns the logical stream name.

Source

pub fn relative_directory(&self) -> &str

Returns the relative directory beneath the recording root.

Source

pub const fn sampling_interval(&self) -> SamplingInterval

Returns the sampling policy.

Source

pub fn fields(&self) -> &[String]

Returns selected state fields in declaration order.

Source

pub const fn storage(&self) -> Option<StateStreamStorage>

Returns stream-specific storage, or None when writer storage applies.

Trait Implementations§

Source§

impl Clone for StateStreamConfig

Source§

fn clone(&self) -> StateStreamConfig

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

impl Debug for StateStreamConfig

Source§

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

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

impl<'de> Deserialize<'de> for StateStreamConfig

Source§

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

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

impl Eq for StateStreamConfig

Source§

impl PartialEq for StateStreamConfig

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for StateStreamConfig

Source§

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

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

impl StructuralPartialEq for StateStreamConfig

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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.