Struct bevy::ecs::system::Res

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

Expand description

Shared borrow of a Resource.

See the Resource documentation for usage.

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 clone(this: &Res<'w, T>) -> Res<'w, T>

pub fn is_added(&self) -> bool

Returns true if the resource was added after the system last ran.

pub fn is_changed(&self) -> bool

Returns true if the resource was added or mutably dereferenced after the system last ran.

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

Trait Implementations

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

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

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

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.

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

Dereferences the value.

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

fn from(res: ResMut<'w, T>) -> Res<'w, T>

Converts to this type from the input type.

impl<'w, 'a, T> IntoIterator for &'a Res<'w, T>where
T: Resource,
&'a T: IntoIterator,

type Item = <&'a T as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'a T as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Res<'w, T> as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

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

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for Twhere
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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

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

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

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 Twhere
T: Any + Send + Sync,

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

source

impl<T> From<T> for T

const: unstable · 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 for Twhere
U: From<T>,

const: unstable · 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.

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

fn par_chunk_map<F, R>(
 &self,
 task_pool: &TaskPool,
 chunk_size: usize,
 f: F
) -> Vec<R, Global>ⓘwhere
 F: Fn(&[T]) -> R + Send + Sync,
 R: 'static + Send,

Splits the slice in chunks of size chunks_size or less and maps the chunks in parallel across the provided task_pool. One task is spawned in the task pool for every chunk. Read more

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

Splits the slice into a maximum of max_tasks chunks, and maps the chunks in parallel across the provided task_pool. One task is spawned in the task pool for every chunk. Read more

source

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

source

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

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

source

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

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

Struct bevy::ecs::system::Res

Panics

Implementations

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

pub fn clone(this: &Res<'w, T>) -> Res<'w, T>

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,

fn as_ref(&self) -> &T

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

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

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

type Target = T

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

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

fn from(res: ResMut<'w, T>) -> Res<'w, T>

impl<'w, 'a, T> IntoIterator for &'a Res<'w, T>where T: Resource, &'a T: IntoIterator,

type Item = <&'a T as IntoIterator>::Item

type IntoIter = <&'a T as IntoIterator>::IntoIter

fn into_iter(self) -> <&'a Res<'w, T> as IntoIterator>::IntoIter

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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘ

fn in_current_span(self) -> Instrumented<Self>ⓘ

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

fn into(self) -> U

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

fn par_chunk_map<F, R>( &self, task_pool: &TaskPool, chunk_size: usize, f: F) -> Vec<R, Global>ⓘ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>ⓘwhere F: Fn(&[T]) -> R + Send + Sync, R: 'static + Send,

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

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

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

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

type Error = Infallible

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

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

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

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

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘwhere S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘ

impl<T> Event for Twhere 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<'w, T> From<ResMut<'w, T>> for Res<'w, T>where
T: Resource,

impl<'w, 'a, T> IntoIterator for &'a Res<'w, T>where
T: Resource,
&'a T: IntoIterator,

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 Twhere
T: 'static + ?Sized,

impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,

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

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

impl<T> Downcast for Twhere
T: Any,

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

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

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

fn par_chunk_map<F, R>(
&self,
task_pool: &TaskPool,
chunk_size: usize,
f: F
) -> Vec<R, Global>ⓘ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>ⓘwhere
F: Fn(&[T]) -> R + Send + Sync,
R: 'static + Send,

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘwhere
S: Into<Dispatch>,

impl<T> Event for Twhere
T: 'static + Send + Sync,