PhaseProvider

maliput::api::rules

Struct PhaseProvider 

Source 
pub struct PhaseProvider<'a> { /* private fields */ }
Expand description

Defines a phase provider.

A phase provider is able to get the current phase from a phase-based system.

Implementations§

Source§

impl<'a> PhaseProvider<'a>

Source

pub fn get_phase( &self, phase_ring_id: &String, ) -> Option<StateProviderQuery<String>>

Returns the [PhaseStateProviderQuery] for the specified phase_ring_id.

The states are represented with Strings containing the IDs of each Phase.

§Arguments
  • phase_ring_id - The id of the phase ring.
§Returns

An Option containing the [PhaseStateProviderQuery] for the given phase_ring_id. Returns None if no phase provider is found for the given id.

Auto Trait Implementations§

§

impl<'a> Freeze for PhaseProvider<'a>

§

impl<'a> RefUnwindSafe for PhaseProvider<'a>

§

impl<'a> !Send for PhaseProvider<'a>

§

impl<'a> !Sync for PhaseProvider<'a>

§

impl<'a> Unpin for PhaseProvider<'a>

§

impl<'a> UnwindSafe for PhaseProvider<'a>

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