BlockingService

Struct BlockingService 

Source
#[non_exhaustive]
pub struct BlockingService<Request, Streams: StreamPack = ()> { pub request: Request, pub streams: Streams::StreamBuffers, pub provider: Entity, pub source: Entity, pub session: Entity, }
Expand description

Use BlockingService to indicate that your system is a blocking Service.

A blocking service will have exclusive world access while it runs, which means no other system will be able to run simultaneously. Each service is associated with its own unique entity which can be used to store state or configuration parameters.

Some services might need to know what entity is providing the service, e.g. if the service provider is configured with additional components that need to be queried when a request comes in. For that you can check the provider field of BlockingService:

use bevy_ecs::prelude::*;
use crossflow::prelude::*;

#[derive(Component, Resource)]
struct Precision(i32);

fn rounding_service(
    In(BlockingService{request, provider, ..}): BlockingServiceInput<f64>,
    service_precision: Query<&Precision>,
    global_precision: Res<Precision>,
) -> f64 {
    let precision = service_precision.get(provider).unwrap_or(&*global_precision).0;
    (request * 10_f64.powi(precision)).floor() * 10_f64.powi(-precision)
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§request: Request

The input data of the request

§streams: Streams::StreamBuffers

The buffer to hold stream output data until the function is finished

§provider: Entity

The entity providing the service

§source: Entity

The node in a workflow or series that asked for the service

§session: Entity

The unique session ID for the workflow

Auto Trait Implementations§

§

impl<Request, Streams> Freeze for BlockingService<Request, Streams>
where Request: Freeze, <Streams as StreamPack>::StreamBuffers: Freeze,

§

impl<Request, Streams> RefUnwindSafe for BlockingService<Request, Streams>
where Request: RefUnwindSafe, <Streams as StreamPack>::StreamBuffers: RefUnwindSafe,

§

impl<Request, Streams> Send for BlockingService<Request, Streams>
where Request: Send, <Streams as StreamPack>::StreamBuffers: Send,

§

impl<Request, Streams> Sync for BlockingService<Request, Streams>
where Request: Sync, <Streams as StreamPack>::StreamBuffers: Sync,

§

impl<Request, Streams> Unpin for BlockingService<Request, Streams>
where Request: Unpin, <Streams as StreamPack>::StreamBuffers: Unpin,

§

impl<Request, Streams> UnwindSafe for BlockingService<Request, Streams>
where Request: UnwindSafe, <Streams as StreamPack>::StreamBuffers: UnwindSafe,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
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, 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.
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Sendish for T
where T: Send,