Struct traffloat::units::Portion[−][src]

pub struct Portion<U> where
    U: Unit,  {
    current: U,
    max: U,
}

Expand description

A unit with a maximum capacity.

Fields

current: U

The current value.

max: U

The maximum capacity.

Implementations

[src]

impl Portion where
U: Unit,

[src]

pub fn empty(max: U) -> Portion

Initializes an empty portion.

[src]

pub fn full(max: U) -> Portion

Initializes a full portion.

[src]

pub fn ratio(self) -> f64

The filled ratio of the portion.

[src]

impl Portion where
U: Unit,

[src]

pub fn new(current: U, max: U) -> Portion

Constructs a new Portion.

[src]

impl Portion where
U: Unit,

[src]

pub fn current(&self) -> U

The current value.

[src]

pub fn max(&self) -> U

The maximum capacity.

Trait Implementations

[src]

impl Clone for Portion where
U: Clone + Unit,

[src]

pub fn clone(&self) -> Portion

Returns a copy of the value. Read more

1.0.0[src]

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

[src]

impl Debug for Portion where
U: Debug + Unit,

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Default for Portion where
U: Default + Unit,

[src]

pub fn default() -> Portion

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

[src]

impl<'de, U> Deserialize<'de> for Portion where
U: Unit,

[src]

pub fn deserialize<D>(
deserializer: D
) -> Result<Portion, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

[src]

impl Display for Portion where
U: Unit + Display,

[src]

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

Formats the value using the given formatter. Read more

[src]

impl PartialEq<Portion> for Portion where
U: PartialEq + Unit,

[src]

pub fn eq(&self, other: &Portion) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

[src]

pub fn ne(&self, other: &Portion) -> bool

This method tests for !=.

[src]

impl Serialize for Portion where
U: Unit,

[src]

pub fn serialize<S>(
 &self,
 serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
 S: Serializer,

Serialize this value into the given Serde serializer. Read more

[src]

impl<T> Xylem<Schema> for Portion<T> where
T: Unit + Xylem<Schema>,

type From = Portion<T>

The type to convert from.

type Args = NoArgs

The args provided in the field. Read more

[src]

pub fn convert_impl(
 from: <Portion<T> as Xylem<Schema>>::From,
 &mut DefaultContext,
 &<Portion<T> as Xylem<Schema>>::Args
) -> Result<Portion<T>, Error>

The implementation of the conversion.

[src]

fn convert(
 from: Self::From,
 context: &mut <S as Schema>::Context,
 args: &Self::Args
) -> Result<Self, <S as Schema>::Error>

Converts the From type to the Self type, registering the scope with the context. Do not override this method. Read more

[src]

impl Copy for Portion where
U: Copy + Unit,

[src]

impl RequiredComponent<Id> for Portion<Hitpoint>

units::Portion<units::Hitpoint> is a required component in the archetype of Id.

[src]

impl RequiredComponent<NodeId> for Portion<Hitpoint>

units::Portion<units::Hitpoint> is a required component in the archetype of NodeId.

[src]

impl StructuralPartialEq for Portion where
U: Unit,

Auto Trait Implementations

impl RefUnwindSafe for Portion where
U: RefUnwindSafe,

impl Send for Portion where
U: Send,

impl Sync for Portion where
U: Sync,

impl Unpin for Portion where
U: Unpin,

impl UnwindSafe for Portion where
U: UnwindSafe,

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]

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

[src]

impl<T> CloneAny for T where
T: Any + Clone,

[src]

pub fn clone_any(&self) -> Box<dyn CloneAny + 'static, Global>

[src]

pub fn clone_any_send(&self) -> Box<dyn CloneAny + Send + 'static, Global> where
T: Send,

[src]

pub fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync + 'static, Global> where
T: Sync,

[src]

pub fn clone_any_send_sync(
&self
) -> Box<dyn CloneAny + Sync + Send + 'static, Global> where
T: Send + Sync,

[src]

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

type Storage = PackedStorage<T>

The storage type required to hold all instances of this component in a world.

[src]

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

[src]

pub 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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

[src]

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

[src]

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

[src]

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

[src]

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T> ToString for T where
T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. 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.

[src]

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

[src]

pub fn vzip(self) -> V

[src]

impl<T> DebugAny for T where
T: Any + Debug,

[src]

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

[src]

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

[src]

impl<T> Resource for T where
T: 'static,

[src]

impl<T> Scalar for T where
T: 'static + Clone + PartialEq<T> + Debug,

[src]

Struct traffloat::units::Portion[−][src]

Fields

Implementations

impl<U> Portion<U> where U: Unit,

pub fn empty(max: U) -> Portion<U>

pub fn full(max: U) -> Portion<U>

pub fn ratio(self) -> f64

impl<U> Portion<U> where U: Unit,

pub fn new(current: U, max: U) -> Portion<U>

impl<U> Portion<U> where U: Unit,

pub fn current(&self) -> U

pub fn max(&self) -> U

Trait Implementations

impl<U> Clone for Portion<U> where U: Clone + Unit,

pub fn clone(&self) -> Portion<U>

fn clone_from(&mut self, source: &Self)

impl<U> Debug for Portion<U> where U: Debug + Unit,

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

impl<U> Default for Portion<U> where U: Default + Unit,

pub fn default() -> Portion<U>

impl<'de, U> Deserialize<'de> for Portion<U> where U: Unit,

pub fn deserialize<__D>( __deserializer: __D) -> Result<Portion<U>, <__D as Deserializer<'de>>::Error> where __D: Deserializer<'de>,

impl<U> Display for Portion<U> where U: Unit + Display,

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

impl<U> PartialEq<Portion<U>> for Portion<U> where U: PartialEq<U> + Unit,

pub fn eq(&self, other: &Portion<U>) -> bool

pub fn ne(&self, other: &Portion<U>) -> bool

impl<U> Serialize for Portion<U> where U: Unit,

pub fn serialize<__S>( &self, __serializer: __S) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where __S: Serializer,

impl<T> Xylem<Schema> for Portion<T> where T: Unit + Xylem<Schema>,

type From = Portion<T>

type Args = NoArgs

pub fn convert_impl( from: <Portion<T> as Xylem<Schema>>::From, &mut DefaultContext, &<Portion<T> as Xylem<Schema>>::Args) -> Result<Portion<T>, Error>

fn convert( from: Self::From, context: &mut <S as Schema>::Context, args: &Self::Args) -> Result<Self, <S as Schema>::Error>

impl<U> Copy for Portion<U> where U: Copy + Unit,

impl RequiredComponent<Id> for Portion<Hitpoint>

impl RequiredComponent<NodeId> for Portion<Hitpoint>

impl<U> StructuralPartialEq for Portion<U> where U: Unit,

Auto Trait Implementations

impl<U> RefUnwindSafe for Portion<U> where U: RefUnwindSafe,

impl<U> Send for Portion<U> where U: Send,

impl<U> Sync for Portion<U> where U: Sync,

impl<U> Unpin for Portion<U> where U: Unpin,

impl<U> UnwindSafe for Portion<U> where U: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> AnyEq for T where T: Any + PartialEq<T>,

pub fn equals(&self, other: &(dyn Any + 'static)) -> bool

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

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> CloneAny for T where T: Any + Clone,

pub fn clone_any(&self) -> Box<dyn CloneAny + 'static, Global>

pub fn clone_any_send(&self) -> Box<dyn CloneAny + Send + 'static, Global> where T: Send,

pub fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync + 'static, Global> where T: Sync,

pub fn clone_any_send_sync( &self) -> Box<dyn CloneAny + Sync + Send + 'static, Global> where T: Send + Sync,

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

type Storage = PackedStorage<T>

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

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

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, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

pub fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

impl<U> Portion<U> where
U: Unit,

impl<U> Portion<U> where
U: Unit,

impl<U> Portion<U> where
U: Unit,

impl<U> Clone for Portion<U> where
U: Clone + Unit,

impl<U> Debug for Portion<U> where
U: Debug + Unit,

impl<U> Default for Portion<U> where
U: Default + Unit,

impl<'de, U> Deserialize<'de> for Portion<U> where
U: Unit,

pub fn deserialize<D>(
deserializer: D
) -> Result<Portion<U>, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

impl<U> Display for Portion<U> where
U: Unit + Display,

impl<U> PartialEq<Portion<U>> for Portion<U> where
U: PartialEq<U> + Unit,

impl<U> Serialize for Portion<U> where
U: Unit,

pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,

impl<T> Xylem<Schema> for Portion<T> where
T: Unit + Xylem<Schema>,

pub fn convert_impl(
from: <Portion<T> as Xylem<Schema>>::From,
&mut DefaultContext,
&<Portion<T> as Xylem<Schema>>::Args
) -> Result<Portion<T>, Error>

fn convert(
from: Self::From,
context: &mut <S as Schema>::Context,
args: &Self::Args
) -> Result<Self, <S as Schema>::Error>

impl<U> Copy for Portion<U> where
U: Copy + Unit,

impl<U> StructuralPartialEq for Portion<U> where
U: Unit,

impl<U> RefUnwindSafe for Portion<U> where
U: RefUnwindSafe,

impl<U> Send for Portion<U> where
U: Send,

impl<U> Sync for Portion<U> where
U: Sync,

impl<U> Unpin for Portion<U> where
U: Unpin,

impl<U> UnwindSafe for Portion<U> where
U: UnwindSafe,

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

impl<T> AnyEq for T where
T: Any + PartialEq<T>,

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

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

impl<T> CloneAny for T where
T: Any + Clone,

pub fn clone_any_send(&self) -> Box<dyn CloneAny + Send + 'static, Global> where
T: Send,

pub fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync + 'static, Global> where
T: Sync,

pub fn clone_any_send_sync(
&self
) -> Box<dyn CloneAny + Sync + Send + 'static, Global> where
T: Send + Sync,

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

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

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

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

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

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

impl<T> DebugAny for T where
T: Any + Debug,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

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

impl<T> Resource for T where
T: 'static,

impl<T> Scalar for T where
T: 'static + Clone + PartialEq<T> + Debug,

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