Skip to main content

SystemDescriptionBuilder

Struct SystemDescriptionBuilder 

Source
pub struct SystemDescriptionBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> SystemDescriptionBuilder<S>

Source

pub fn build(self) -> SystemDescription
where S: IsComplete,

Finish building and return the requested object

Source

pub fn message_id(self, value: Id) -> SystemDescriptionBuilder<SetMessageId<S>>
where S::MessageId: IsUnset,

Optional (Some / Option setters). Default: Id::generate().

This message’s identifier.

Source

pub fn maybe_message_id( self, value: Option<Id>, ) -> SystemDescriptionBuilder<SetMessageId<S>>
where S::MessageId: IsUnset,

Optional (Some / Option setters). Default: Id::generate().

This message’s identifier.

Source

pub fn valid_from( self, value: Timestamp, ) -> SystemDescriptionBuilder<SetValidFrom<S>>
where S::ValidFrom: IsUnset,

Required.

When this description becomes valid.

Source

pub fn actuators( self, value: Vec<ActuatorDescription>, ) -> SystemDescriptionBuilder<SetActuators<S>>
where S::Actuators: IsUnset,

Required.

Every actuator. At least one, at most ten.

Source

pub fn present_demand_rate( self, value: NumberRange, ) -> SystemDescriptionBuilder<SetPresentDemandRate<S>>
where S::PresentDemandRate: IsUnset,

Optional (Some / Option setters). The demand that must be satisfied right now.

Required in v0.0.2-beta and absent in v1.0.0, where it became PresentDemandStatus. The codec enforces whichever the negotiated profile requires, so this is the one field whose optionality is a function of the version .

Source

pub fn maybe_present_demand_rate( self, value: Option<NumberRange>, ) -> SystemDescriptionBuilder<SetPresentDemandRate<S>>
where S::PresentDemandRate: IsUnset,

Optional (Some / Option setters). The demand that must be satisfied right now.

Required in v0.0.2-beta and absent in v1.0.0, where it became PresentDemandStatus. The codec enforces whichever the negotiated profile requires, so this is the one field whose optionality is a function of the version .

Source

pub fn provides_average_demand_rate_forecast( self, value: bool, ) -> SystemDescriptionBuilder<SetProvidesAverageDemandRateForecast<S>>
where S::ProvidesAverageDemandRateForecast: IsUnset,

Required.

Whether an AverageDemandRateForecast may follow.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

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