CVarManagement

Struct CVarManagement 

Source
pub struct CVarManagement { /* private fields */ }
Expand description

App resource that provides management information and functionality for CVars.

Implementations§

Source§

impl CVarManagement

Source

pub fn get_cvar_reflect<'a>( &self, world: &'a World, cvar: &str, ) -> Result<&'a dyn Reflect, CVarError>

Gets a CVar’s value through reflection.

§Remarks

This returns the inner value, not the cvar resource itself.

Source

pub fn get_cvar_reflect_mut<'a>( &self, world: &'a mut World, cvar: &str, ) -> Result<Mut<'a, dyn Reflect>, CVarError>

Gets a CVar’s value mutably through reflection.

§Remarks

This returns the inner value, not the cvar resource itself. A change-detection aware handle is returned.

Source

pub fn set_cvar_reflect( &self, world: &mut World, cvar: &str, value: &dyn Reflect, ) -> Result<(), CVarError>

Set a CVar to the given reflected value using reflection.

§Remarks

Use the WorldExtensions version if you can, it handles the invariants. This is harder to call than it looks due to needing mutable world.

Source

pub fn set_cvar_reflect_no_change( &self, world: &mut World, cvar: &str, value: &dyn Reflect, ) -> Result<(), CVarError>

Set a CVar to the given reflected value using reflection, without triggering change detection.

§Remarks

Use the WorldExtensions version if you can, it handles the invariants. This is harder to call than it looks due to needing mutable world.

Source

pub fn set_cvar_deserialize<'w, 'a>( &self, world: &mut World, cvar: &str, value: impl Deserializer<'a>, ) -> Result<(), CVarError>

Set a CVar to the given deserializable value using reflection.

§Remarks

Use the WorldExtensions version if you can, it handles the invariants. This is harder to call than it looks due to needing mutable world.

Source

pub fn set_cvar_deserialize_no_change<'w, 'a>( &self, world: &mut World, cvar: &str, value: impl Deserializer<'a>, ) -> Result<(), CVarError>

Set a CVar to the given deserializable value using reflection, without triggering change detection.

§Remarks

Use the WorldExtensions version if you can, it handles the invariants. This is harder to call than it looks due to needing mutable world.

Source

pub fn iterate_cvar_types(&self) -> impl Iterator<Item = &TypeRegistration>

Returns an iterator for all CVar type registrations.

Trait Implementations§

Source§

impl Default for CVarManagement

Source§

fn default() -> CVarManagement

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

impl Resource for CVarManagement
where Self: Send + Sync + 'static,

Auto Trait Implementations§

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> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

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 = 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> 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
Source§

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

Source§

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