Struct bevy::ecs::system::Res[−]

pub struct Res<'w, T> where
    T: Resource,  { /* fields omitted */ }

Expand description

Shared borrow of a resource.

See the World documentation to see the usage of a resource.

If you need a unique mutable borrow, use ResMut instead.

Panics

Panics when used as a SystemParameter if the resource does not exist.

Use Option<Res<T>> instead if the resource might not always exist.

Implementations

impl<'w, T> Res<'w, T> where
T: Resource,

pub fn is_added(&self) -> bool

Returns true if (and only if) this resource been added since the last execution of this system.

pub fn is_changed(&self) -> bool

Returns true if (and only if) this resource been changed since the last execution of this system.

pub fn into_inner(self) -> &'w T

Trait Implementations

impl<'w, T> AsRef<T> for Res<'w, T> where
T: Resource,

pub fn as_ref(&self) -> &T

Performs the conversion.

impl<'w, T> Debug for Res<'w, T> where
T: Resource + Debug,

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

Formats the value using the given formatter. Read more

impl<'w, T> Deref for Res<'w, T> where
T: Resource,

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &<Res<'w, T> as Deref>::Target

Dereferences the value.

impl<'a, T> SystemParam for Res<'a, T> where
T: Resource,

type Fetch = ResState<T>

Auto Trait Implementations

impl<'w, T> RefUnwindSafe for Res<'w, T> where
T: RefUnwindSafe,

impl<'w, T> Send for Res<'w, T>

impl<'w, T> Sync for Res<'w, T>

impl<'w, T> Unpin for Res<'w, T>

impl<'w, T> UnwindSafe for Res<'w, T> where
T: RefUnwindSafe,

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘ
Notable traits for Box<I, A>
`impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;`

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

impl<S, T> ParallelSlice<T> for S where
T: Sync,
S: AsRef<[T]>,

fn par_chunk_map<F, R>(
 &self,
 task_pool: &TaskPool,
 chunk_size: usize,
 f: F
) -> Vec<R, Global>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`
where
 F: Fn(&[T]) -> R + Send + Sync,
 R: 'static + Send,

fn par_splat_map<F, R>(
 &self,
 task_pool: &TaskPool,
 max_tasks: Option<usize>,
 f: F
) -> Vec<R, Global>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`
where
 F: Fn(&[T]) -> R + Send + Sync,
 R: 'static + Send,

[src]

impl<T> ToHex for T where
T: AsRef<[u8 ]>,

[src]

pub fn encode_hex(&self) -> U where
U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca) Read more

[src]

pub fn encode_hex_upper(&self) -> U where
U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA) Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct bevy::ecs::system::Res[−]

Panics

Implementations

impl<'w, T> Res<'w, T> where T: Resource,

pub fn is_added(&self) -> bool

pub fn is_changed(&self) -> bool

pub fn into_inner(self) -> &'w T

Trait Implementations

impl<'w, T> AsRef<T> for Res<'w, T> where T: Resource,

pub fn as_ref(&self) -> &T

impl<'w, T> Debug for Res<'w, T> where T: Resource + Debug,

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

impl<'w, T> Deref for Res<'w, T> where T: Resource,

type Target = T

pub fn deref(&self) -> &<Res<'w, T> as Deref>::Target

impl<'a, T> SystemParam for Res<'a, T> where T: Resource,

type Fetch = ResState<T>

Auto Trait Implementations

impl<'w, T> RefUnwindSafe for Res<'w, T> where T: RefUnwindSafe,

impl<'w, T> Send for Res<'w, T>

impl<'w, T> Sync for Res<'w, T>

impl<'w, T> Unpin for Res<'w, T>

impl<'w, T> UnwindSafe for Res<'w, T> where T: RefUnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

impl<T> DowncastSync for T where T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<S, T> ParallelSlice<T> for S where T: Sync, S: AsRef<[T]>,

fn par_chunk_map<F, R>( &self, task_pool: &TaskPool, chunk_size: usize, f: F) -> Vec<R, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator, where F: Fn(&[T]) -> R + Send + Sync, R: 'static + Send,

fn par_splat_map<F, R>( &self, task_pool: &TaskPool, max_tasks: Option<usize>, f: F) -> Vec<R, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator, where F: Fn(&[T]) -> R + Send + Sync, R: 'static + Send,

impl<T> ToHex for T where T: AsRef<[u8]>,

pub fn encode_hex<U>(&self) -> U where U: FromIterator<char>,

pub fn encode_hex_upper<U>(&self) -> U where U: FromIterator<char>,

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output; where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;

impl<T> Resource for T where T: 'static + Send + Sync,

impl<'w, T> Res<'w, T> where
T: Resource,

impl<'w, T> AsRef<T> for Res<'w, T> where
T: Resource,

impl<'w, T> Debug for Res<'w, T> where
T: Resource + Debug,

impl<'w, T> Deref for Res<'w, T> where
T: Resource,

impl<'a, T> SystemParam for Res<'a, T> where
T: Resource,

impl<'w, T> RefUnwindSafe for Res<'w, T> where
T: RefUnwindSafe,

impl<'w, T> UnwindSafe for Res<'w, T> where
T: RefUnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘ
Notable traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

impl<T, U> Into<U> for T where
U: From<T>,

impl<S, T> ParallelSlice<T> for S where
T: Sync,
S: AsRef<[T]>,

fn par_chunk_map<F, R>(
&self,
task_pool: &TaskPool,
chunk_size: usize,
f: F
) -> Vec<R, Global>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`
where
F: Fn(&[T]) -> R + Send + Sync,
R: 'static + Send,

fn par_splat_map<F, R>(
&self,
task_pool: &TaskPool,
max_tasks: Option<usize>,
f: F
) -> Vec<R, Global>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`
where
F: Fn(&[T]) -> R + Send + Sync,
R: 'static + Send,

impl<T> ToHex for T where
T: AsRef<[u8 ]>,

pub fn encode_hex<U>(&self) -> U where
U: FromIterator<char>,

pub fn encode_hex_upper<U>(&self) -> U where
U: FromIterator<char>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘ
Notable traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

impl<T> Resource for T where
T: 'static + Send + Sync,