Skip to main content

Port

Struct Port 

Source
pub struct Port<CID, SID, CA, CS, CM>
where SID: EzShipIds, CA: EzArgs, CS: EzState, CM: EzMsg,
{ /* private fields */ }
Expand description

The port is the struct that holds all your ships. Like the [View], you’ll only have one port in your app but as many ships as you want. Again like the [View], the port is the orchestrator of your ships. It will send the forward to/from the ships and your app.

Implementations§

Source§

impl<CID, SID, CA, CS, CM> Port<CID, SID, CA, CS, CM>
where CID: EzCptIds, SID: EzShipIds, CA: EzArgs, CS: EzState, CM: EzMsg,

Source

pub fn init(&mut self, tx: &Sender<EzEvent<CID, CM>>)

Initialize a new empty port

Source

pub fn register( &mut self, id: SID, ship: BoxedShip<CID, CA, CS, CM>, ) -> Result<()>

Add a new ship to the port

§Errors
Source

pub fn unregister(&mut self, id: &SID) -> Result<()>

Remove the ship with given id from the port

§Errors
Source

pub fn registered(&self, id: &SID) -> bool

Check if the ship with given id is registered in the port

Source

pub fn query_ship( &self, _: &EzShipId<SID>, _: Attribute, ) -> Result<Option<AttrValue>>

Query a component for an attribute

§Errors

None for now

Source

pub fn set_ship_attr( &mut self, _: &EzShipId<SID>, _: Attribute, _: AttrValue, ) -> Result<()>

Set an attribute to a component

§Errors

None for now

Trait Implementations§

Source§

impl<CID: Debug, SID, CA, CS, CM> Debug for Port<CID, SID, CA, CS, CM>
where SID: EzShipIds + Debug, CA: EzArgs + Debug, CS: EzState + Debug, CM: EzMsg + Debug,

Source§

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

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

impl<CID, SID, CA, CS, CM> Default for Port<CID, SID, CA, CS, CM>
where CID: EzCptIds, SID: EzShipIds, CA: EzArgs, CS: EzState, CM: EzMsg,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<CID, SID, CA, CS, CM> !RefUnwindSafe for Port<CID, SID, CA, CS, CM>

§

impl<CID, SID, CA, CS, CM> !Send for Port<CID, SID, CA, CS, CM>

§

impl<CID, SID, CA, CS, CM> !Sync for Port<CID, SID, CA, CS, CM>

§

impl<CID, SID, CA, CS, CM> !UnwindSafe for Port<CID, SID, CA, CS, CM>

§

impl<CID, SID, CA, CS, CM> Freeze for Port<CID, SID, CA, CS, CM>
where LinkedHashMap<EzShipId<SID>, Box<dyn Ship<CID, CA, CS, CM>>>: Freeze,

§

impl<CID, SID, CA, CS, CM> Unpin for Port<CID, SID, CA, CS, CM>
where LinkedHashMap<EzShipId<SID>, Box<dyn Ship<CID, CA, CS, CM>>>: Unpin,

§

impl<CID, SID, CA, CS, CM> UnsafeUnpin for Port<CID, SID, CA, CS, CM>
where LinkedHashMap<EzShipId<SID>, Box<dyn Ship<CID, CA, CS, CM>>>: UnsafeUnpin,

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