pub struct ObservationStream { /* private fields */ }Expand description
One application-defined scientific observation stream.
Implementations§
Source§impl ObservationStream
impl ObservationStream
Sourcepub fn all_fields(name: impl Into<String>) -> Result<Self, ObservationError>
pub fn all_fields(name: impl Into<String>) -> Result<Self, ObservationError>
Defines a named stream containing every field in its bound state schema.
The name is trimmed and remains a scientific identifier rather than a filesystem path.
§Errors
Returns ObservationError::EmptyStreamName when the normalized name
is empty.
Sourcepub fn fields<I, S>(
name: impl Into<String>,
fields: I,
) -> Result<Self, ObservationError>
pub fn fields<I, S>( name: impl Into<String>, fields: I, ) -> Result<Self, ObservationError>
Defines a named stream containing the selected state fields.
Stream and field names are trimmed. Selection order is accepted as application input but schema binding later restores canonical schema order.
§Errors
Returns ObservationError::EmptyStreamName,
ObservationError::EmptyFieldName,
ObservationError::EmptyFieldSelection, or
ObservationError::DuplicateField for an invalid declaration.
Sourcepub fn every_iterations(self, iterations: u64) -> Result<Self, ObservationError>
pub fn every_iterations(self, iterations: u64) -> Result<Self, ObservationError>
Changes this stream’s cadence from every iteration to every iterations.
Iteration zero and every iteration divisible by this positive interval are selected. The terminal state is handled independently by the private observation session.
§Errors
Returns ObservationError::InvalidSamplingInterval when iterations
is zero.
Sourcepub fn initial_and_final(self) -> Self
pub fn initial_and_final(self) -> Self
Records the initial state and successful final state, with no intermediate records.
An already-complete initial state is recorded once. This replaces any
previously selected interval; a later every_iterations replaces it.
Boundary-only metadata requires recording format 8.
Trait Implementations§
Source§impl Clone for ObservationStream
impl Clone for ObservationStream
Source§impl Debug for ObservationStream
impl Debug for ObservationStream
impl Eq for ObservationStream
Source§impl PartialEq for ObservationStream
impl PartialEq for ObservationStream
impl StructuralPartialEq for ObservationStream
Auto Trait Implementations§
impl Freeze for ObservationStream
impl RefUnwindSafe for ObservationStream
impl Send for ObservationStream
impl Sync for ObservationStream
impl Unpin for ObservationStream
impl UnsafeUnpin for ObservationStream
impl UnwindSafe for ObservationStream
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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