Skip to main content

Value

Enum Value

pub enum Value {
    Void,
    Entity(EntityRef),
    Function(Arc<dyn ErasedFunction>),
    Float(f32),
    Vector(Vec3),
    String(Arc<CStr>),
}

Expand description

The type of individual values passed in and out of the QuakeC runtime. Note that, in most cases, Void will be converted to the default value for the type.

Variants§

Void

Corresponds to QuakeC’s void. Should rarely be used, and is mostly for the return value of functions that do not return any sensible value.

Entity(EntityRef)

An entity reference. See documentation for EntityRef for more details.

Function(Arc<dyn ErasedFunction>)

A function pointer. This requires some context to call, see userdata::Function.

Float(f32)

A single scalar float.

Vector(Vec3)

An {x, y, z} vector value.

String(Arc<CStr>)

A refcounted string pointer. Quake strings are not strictly ascii, but cannot have internal NUL, so CStr is used.

Implementations§

impl Value

pub const fn type_(&self) -> Type

The Type of this value.

pub fn field(&self, field: VectorField) -> Result<Value, TryScalarError>

Get a field of a value.

pub fn set( &mut self, field: VectorField, value: Value, ) -> Result<(), SetValueError>

Clone the source value to this value, with an optional field reference. Useful to implement userdata::EntityHandle::set, as sometimes QuakeC only wants to set a single field of a vector.

Trait Implementations§

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Value

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

Formats the value using the given formatter. Read more

impl From<[f32; 3]> for Value

fn from(value: [f32; 3]) -> Self

Converts to this type from the input type.

impl From<Arc<CStr>> for Value

fn from(value: Arc<CStr>) -> Self

Converts to this type from the input type.

impl From<Arc<dyn ErasedFunction>> for Value

fn from(value: Arc<dyn ErasedFunction>) -> Self

Converts to this type from the input type.

impl From<EntityRef> for Value

fn from(value: EntityRef) -> Self

Converts to this type from the input type.

impl From<ErasedEntityHandle> for Value

fn from(value: ErasedEntityHandle) -> Self

Converts to this type from the input type.

impl From<Vec3> for Value

fn from(value: Vec3) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i128> for Value

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Value

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Value

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Value

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Value

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Value

fn from(value: usize) -> Self

Converts to this type from the input type.

impl PartialEq for Value

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for Value

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<[VmScalar; 3]> for Value

type Error = <VmScalar as TryInto<f32>>::Error

The type returned in the event of a conversion error.

fn try_from(value: [VmScalar; 3]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Arc<CStr>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Arc<dyn ErasedFunction>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for EntityRef

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for ErasedEntityHandle

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Vec3

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for f32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Value

Auto Trait Implementations§

impl Freeze for Value

impl !RefUnwindSafe for Value

impl Send for Value

impl Sync for Value

impl Unpin for Value

impl UnsafeUnpin for Value

impl !UnwindSafe for Value

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

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

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

Dynamic version of PartialEq::eq.

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

Dynamic version of PartialEq::ne.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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<T> IntoEither for T

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

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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