Skip to main content

WireVariant

Enum WireVariant 

Source
pub enum WireVariant {
    Number(f64),
    Int(i64),
    Bool(bool),
    Object(Option<usize>),
    Exec,
    Vector(Vector3f),
    Rotator {
        pitch: f64,
        yaw: f64,
        roll: f64,
    },
    Quat {
        x: f64,
        y: f64,
        z: f64,
        w: f64,
    },
    Str(String),
    LinearColor {
        r: f32,
        g: f32,
        b: f32,
        a: f32,
    },
}
Expand description

A wire graph variant value. The members mirror the engine’s WireGraphVariant union (f64, i64, bool, weak_object, WireGraphExec, Vector, Rotator, Quat, str, LinearColor); WireGraphPrimMathVariant uses the numeric/spatial subset.

Variants§

§

Number(f64)

§

Int(i64)

§

Bool(bool)

§

Object(Option<usize>)

weak_object member: an object/asset reference, stored as an index into global_data.external_asset_references (None is a null reference).

§

Exec

§

Vector(Vector3f)

Vector member (X, Y, Z).

§

Rotator

Rotator member (Pitch, Yaw, Roll — f64 degrees).

Fields

§pitch: f64
§yaw: f64
§roll: f64
§

Quat

Quat member (X, Y, Z, W — f64).

Fields

§

Str(String)

str member: a string value.

§

LinearColor

LinearColor member (R, G, B, A — f32, linear 0–1).

Fields

Trait Implementations§

Source§

impl AsBrdbValue for WireVariant

Source§

fn as_brdb_wire_variant(&self) -> Result<WireVariant, BrdbSchemaError>

Source§

fn as_brdb_bool(&self) -> Result<bool, BrdbSchemaError>

Source§

fn as_brdb_u8(&self) -> Result<u8, BrdbSchemaError>

Source§

fn as_brdb_u16(&self) -> Result<u16, BrdbSchemaError>

Source§

fn as_brdb_u32(&self) -> Result<u32, BrdbSchemaError>

Source§

fn as_brdb_u64(&self) -> Result<u64, BrdbSchemaError>

Source§

fn as_brdb_i8(&self) -> Result<i8, BrdbSchemaError>

Source§

fn as_brdb_i16(&self) -> Result<i16, BrdbSchemaError>

Source§

fn as_brdb_i32(&self) -> Result<i32, BrdbSchemaError>

Source§

fn as_brdb_i64(&self) -> Result<i64, BrdbSchemaError>

Source§

fn as_brdb_f32(&self) -> Result<f32, BrdbSchemaError>

Source§

fn as_brdb_f64(&self) -> Result<f64, BrdbSchemaError>

Source§

fn as_brdb_str(&self) -> Result<&str, BrdbSchemaError>

Source§

fn as_brdb_asset( &self, _schema: &BrdbSchema, _ty: &str, ) -> Result<Option<usize>, BrdbSchemaError>

Source§

fn as_brdb_enum( &self, _schema: &BrdbSchema, _def: &BrdbSchemaEnum, ) -> Result<i32, BrdbSchemaError>

Source§

fn as_brdb_wire_array_variant( &self, ) -> Result<WireArrayVariant, BrdbSchemaError>

Source§

fn as_brdb_wire_map_variant(&self) -> Result<WireMapVariant, BrdbSchemaError>

Source§

fn as_brdb_variant_member(&self) -> Option<&str>

When this value should encode as a named member of a schema variant (a tagged union whose members are structs, e.g. BRInventoryEntryVariant -> BRInventoryEntryNothing), return the member struct’s name. The writer emits uint(tag) + <that struct>. None (the default) means “not a struct-member variant” and the writer falls back to the wire map/array/scalar variant paths.
Source§

fn has_brdb_struct_prop( &self, _schema: &BrdbSchema, _struct_name: BrdbInterned, _prop_name: BrdbInterned, ) -> bool

Cheap presence probe for a struct property. When this returns false, the schema writer takes the default/zero path directly instead of paying for a MissingStructField error (two String allocations) per unset field. Implementations that can’t answer cheaply keep the default true; the writer then falls back to the erroring accessors below.
Source§

fn as_brdb_struct_prop_value( &self, _schema: &BrdbSchema, _struct_name: BrdbInterned, _prop_name: BrdbInterned, ) -> Result<&dyn AsBrdbValue, BrdbSchemaError>

Read a specific struct property value from the schema.
Source§

fn as_brdb_struct_prop_array( &self, _schema: &BrdbSchema, _struct_name: BrdbInterned, _prop_name: BrdbInterned, ) -> Result<BrdbArrayIter<'_>, BrdbSchemaError>

Get the the number of entries in a struct property.
Source§

fn as_brdb_struct_prop_map( &self, _schema: &BrdbSchema, _struct_name: BrdbInterned, _prop_name: BrdbInterned, ) -> Result<BrdbMapIter<'_>, BrdbSchemaError>

Get the the number of entries in a struct property.
Source§

impl Clone for WireVariant

Source§

fn clone(&self) -> WireVariant

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WireVariant

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WireVariant

Source§

fn default() -> Self

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

impl Display for WireVariant

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&str> for WireVariant

Source§

fn from(value: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for WireVariant

Source§

fn from(value: String) -> Self

Converts to this type from the input type.
Source§

impl From<Vector3f> for WireVariant

Source§

fn from(value: Vector3f) -> Self

Converts to this type from the input type.
Source§

impl From<WireMapKeyData> for WireVariant

Source§

fn from(k: WireMapKeyData) -> Self

Converts to this type from the input type.
Source§

impl From<WireMapValueData> for WireVariant

Source§

fn from(v: WireMapValueData) -> Self

Converts to this type from the input type.
Source§

impl From<WireVariant> for WireMapValueData

Source§

fn from(v: WireVariant) -> Self

Converts to this type from the input type.
Source§

impl From<WireVariant> for WireMapKeyData

Source§

fn from(v: WireVariant) -> Self

Converts to this type from the input type.
Source§

impl From<bool> for WireVariant

Source§

fn from(value: bool) -> Self

Converts to this type from the input type.
Source§

impl From<f32> for WireVariant

Source§

fn from(value: f32) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for WireVariant

Source§

fn from(value: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i8> for WireVariant

Source§

fn from(value: i8) -> Self

Converts to this type from the input type.
Source§

impl From<i16> for WireVariant

Source§

fn from(value: i16) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for WireVariant

Source§

fn from(value: i32) -> Self

Converts to this type from the input type.
Source§

impl From<i64> for WireVariant

Source§

fn from(value: i64) -> Self

Converts to this type from the input type.
Source§

impl From<u8> for WireVariant

Source§

fn from(value: u8) -> Self

Converts to this type from the input type.
Source§

impl From<u16> for WireVariant

Source§

fn from(value: u16) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for WireVariant

Source§

fn from(value: u32) -> Self

Converts to this type from the input type.
Source§

impl From<u64> for WireVariant

Source§

fn from(value: u64) -> Self

Converts to this type from the input type.
Source§

impl TryFrom<&BrdbValue> for WireVariant

Convert a decoded value back into a WireVariant. Named variants decode to raw BrdbValues (the tag is consumed on read); legacy variants decode to a WireVar. Both round-trip here.

Source§

type Error = BrdbSchemaError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.

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> CloneToUninit for T
where T: Clone,

Source§

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

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