Skip to main content

ObservationPlan

Struct ObservationPlan 

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

An immutable application definition of scientific observation.

Implementations§

Source§

impl ObservationPlan

Source

pub fn all_fields() -> Self

Defines one inferred stream named state containing every state field.

This declaration is infallible. Binding later rejects an empty state schema because every observation stream must contain at least one field.

Source

pub fn fields<I, S>(fields: I) -> Result<Self, ObservationError>
where I: IntoIterator<Item = S>, S: Into<String>,

Defines one inferred stream named state containing selected fields.

Field names are trimmed and must be nonempty and unique. Their existence is checked later against the execution unit’s state schema.

§Errors

Returns ObservationError::EmptyFieldName, ObservationError::EmptyFieldSelection, or ObservationError::DuplicateField for an invalid declaration.

Source

pub fn streams<I>(streams: I) -> Result<Self, ObservationError>

Defines several explicitly named scientific streams.

Definition order is retained. Stream constructors already normalize names; this operation rejects an empty plan and repeated normalized names.

§Errors

Returns ObservationError::EmptyPlan or ObservationError::DuplicateStreamName.

Source

pub fn with_iteration_unit( self, unit: impl Into<String>, ) -> Result<Self, ObservationError>

Attaches an optional scientific unit to the inferred iteration axis.

Surrounding whitespace is removed.

§Errors

Returns ObservationError::EmptyAxisUnit when the normalized unit is empty.

Source

pub fn with_physical_time_unit( self, unit: impl Into<String>, ) -> Result<Self, ObservationError>

Attaches an optional scientific unit to the inferred physical_time axis.

Surrounding whitespace is removed.

§Errors

Returns ObservationError::EmptyAxisUnit when the normalized unit is empty.

Trait Implementations§

Source§

impl Clone for ObservationPlan

Source§

fn clone(&self) -> Self

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 ObservationPlan

Source§

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

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

impl Eq for ObservationPlan

Source§

impl PartialEq for ObservationPlan

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ObservationPlan

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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<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> Same for T

Source§

type Output = T

Should always be Self
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.