Enum rbx_types::Variant

#[non_exhaustive]
pub enum Variant {
    Axes(Axes),
    BinaryString(BinaryString),
    Bool(bool),
    BrickColor(BrickColor),
    CFrame(CFrame),
    Color3(Color3),
    Color3uint8(Color3uint8),
    ColorSequence(ColorSequence),
    Content(Content),
    Enum(Enum),
    Faces(Faces),
    Float32(f32),
    Float64(f64),
    Int32(i32),
    Int64(i64),
    NumberRange(NumberRange),
    NumberSequence(NumberSequence),
    PhysicalProperties(PhysicalProperties),
    Ray(Ray),
    Rect(Rect),
    Ref(Ref),
    Region3(Region3),
    Region3int16(Region3int16),
    SharedString(SharedString),
    String(String),
    UDim(UDim),
    UDim2(UDim2),
    Vector2(Vector2),
    Vector2int16(Vector2int16),
    Vector3(Vector3),
    Vector3int16(Vector3int16),
    OptionalCFrame(Option<CFrame>),
    Tags(Tags),
    Attributes(Attributes),
    Font(Font),
    UniqueId(UniqueId),
    MaterialColors(MaterialColors),
    SecurityCapabilities(SecurityCapabilities),
}

Represents any Roblox type. Useful for operating generically on Roblox instances.

Stability

New variants may be added to Variant in minor releases. As such, it is marked #[non_exhaustive].

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Axes(Axes)

BinaryString(BinaryString)

Bool(bool)

BrickColor(BrickColor)

CFrame(CFrame)

Color3(Color3)

Color3uint8(Color3uint8)

ColorSequence(ColorSequence)

Content(Content)

Enum(Enum)

Faces(Faces)

Float32(f32)

Float64(f64)

Int32(i32)

Int64(i64)

NumberRange(NumberRange)

NumberSequence(NumberSequence)

PhysicalProperties(PhysicalProperties)

Ray(Ray)

Rect(Rect)

Ref(Ref)

Region3(Region3)

Region3int16(Region3int16)

SharedString(SharedString)

String(String)

UDim(UDim)

UDim2(UDim2)

Vector2(Vector2)

Vector2int16(Vector2int16)

Vector3(Vector3)

Vector3int16(Vector3int16)

OptionalCFrame(Option<CFrame>)

Tags(Tags)

Attributes(Attributes)

Font(Font)

UniqueId(UniqueId)

MaterialColors(MaterialColors)

SecurityCapabilities(SecurityCapabilities)

Implementations

impl Variant

pub fn ty(&self) -> VariantType

Trait Implementations

impl Clone for Variant

fn clone(&self) -> Variant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Variant

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

Formats the value using the given formatter.

impl From<&str> for Variant

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Attributes> for Variant

fn from(value: Attributes) -> Self

Converts to this type from the input type.

impl From<Axes> for Variant

fn from(value: Axes) -> Self

Converts to this type from the input type.

impl From<BinaryString> for Variant

fn from(value: BinaryString) -> Self

Converts to this type from the input type.

impl From<BrickColor> for Variant

fn from(value: BrickColor) -> Self

Converts to this type from the input type.

impl From<CFrame> for Variant

fn from(value: CFrame) -> Self

Converts to this type from the input type.

impl From<Color3> for Variant

fn from(value: Color3) -> Self

Converts to this type from the input type.

impl From<Color3uint8> for Variant

fn from(value: Color3uint8) -> Self

Converts to this type from the input type.

impl From<ColorSequence> for Variant

fn from(value: ColorSequence) -> Self

Converts to this type from the input type.

impl From<Content> for Variant

fn from(value: Content) -> Self

Converts to this type from the input type.

impl From<Enum> for Variant

fn from(value: Enum) -> Self

Converts to this type from the input type.

impl From<Faces> for Variant

fn from(value: Faces) -> Self

Converts to this type from the input type.

impl From<Font> for Variant

fn from(value: Font) -> Self

Converts to this type from the input type.

impl From<MaterialColors> for Variant

fn from(value: MaterialColors) -> Self

Converts to this type from the input type.

impl From<NumberRange> for Variant

fn from(value: NumberRange) -> Self

Converts to this type from the input type.

impl From<NumberSequence> for Variant

fn from(value: NumberSequence) -> Self

Converts to this type from the input type.

impl From<Option<CFrame>> for Variant

fn from(value: Option<CFrame>) -> Self

Converts to this type from the input type.

impl From<PhysicalProperties> for Variant

fn from(value: PhysicalProperties) -> Self

Converts to this type from the input type.

impl From<Ray> for Variant

fn from(value: Ray) -> Self

Converts to this type from the input type.

impl From<Rect> for Variant

fn from(value: Rect) -> Self

Converts to this type from the input type.

impl From<Ref> for Variant

fn from(value: Ref) -> Self

Converts to this type from the input type.

impl From<Region3> for Variant

fn from(value: Region3) -> Self

Converts to this type from the input type.

impl From<Region3int16> for Variant

fn from(value: Region3int16) -> Self

Converts to this type from the input type.

impl From<SecurityCapabilities> for Variant

fn from(value: SecurityCapabilities) -> Self

Converts to this type from the input type.

impl From<SharedString> for Variant

fn from(value: SharedString) -> Self

Converts to this type from the input type.

impl From<String> for Variant

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Tags> for Variant

fn from(value: Tags) -> Self

Converts to this type from the input type.

impl From<UDim> for Variant

fn from(value: UDim) -> Self

Converts to this type from the input type.

impl From<UDim2> for Variant

fn from(value: UDim2) -> Self

Converts to this type from the input type.

impl From<UniqueId> for Variant

fn from(value: UniqueId) -> Self

Converts to this type from the input type.

impl From<Vector2> for Variant

fn from(value: Vector2) -> Self

Converts to this type from the input type.

impl From<Vector2int16> for Variant

fn from(value: Vector2int16) -> Self

Converts to this type from the input type.

impl From<Vector3> for Variant

fn from(value: Vector3) -> Self

Converts to this type from the input type.

impl From<Vector3int16> for Variant

fn from(value: Vector3int16) -> Self

Converts to this type from the input type.

impl From<bool> for Variant

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Variant

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Variant

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Variant

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Variant

fn from(value: i64) -> Self

Converts to this type from the input type.

impl PartialEq for Variant

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

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

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

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

impl StructuralPartialEq for Variant