Struct jlrs::value::datatype::DataType

#[repr(transparent)]pub struct DataType<'frame>(_, _);

Julia type information. You can acquire a Value’s datatype by by calling Value::datatype. This struct implements JuliaTypecheck and Cast. It can be used in combination with DataType::is and Value::is; if the check returns true the Value can be cast to DataType:

julia.frame(2, |global, frame| {
    let val = Value::new(frame, 1u8)?;
    let typeof_func = Module::core(global).function("typeof")?;
    let ty_val = typeof_func.call1(frame, val)?.unwrap();
    assert!(ty_val.is::<DataType>());
    assert!(ty_val.cast::<DataType>().is_ok());
    Ok(())
}).unwrap();

Implementations

impl<'frame> DataType<'frame>

pub fn is<T: JuliaTypecheck>(self) -> bool

Performs the given typecheck.

pub fn size(self) -> i32

Returns the size of a value of this type in bytes.

pub fn align(self) -> u16

Returns the alignment of a value of this type in bytes.

pub fn nbits(self) -> i32

Returns the size of a value of this type in bits.

pub fn nfields(self) -> u32

Returns the number of fields of a value of this type.

pub fn isinlinealloc(self) -> bool

Returns true if a value of this type stores its data inline.

pub fn name(self) -> &'frame str

Returns the name of this type.

pub fn type_name(self) -> TypeName<'frame>

Returns the TypeName of this type.

pub fn field_names(self) -> &'frame [Symbol<'frame>]

Returns the field names of this type as a slice of Symbols. These symbols can be used to access their fields with Value::get_field.

pub fn field_types(self) -> &'frame [Value<'frame, 'static>]

Returns the field types of this type.

pub fn field_size(self, idx: usize) -> u32

Returns the size of the field at position idx in this type.

pub fn field_offset(self, idx: usize) -> u32

Returns the offset where the field at position idx is stored.

pub fn is_pointer_field(self, idx: usize) -> bool

Returns true if the field at position idx is a pointer.

pub fn isbits(self) -> bool

Returns true if this type is a bits-type.

pub fn super_type(self) -> Option<Self>

Returns the supertype of this type.

pub fn parameters(self) -> &'frame [Value<'frame, 'static>]

Returns the type parameters of this type.

pub fn instance(self) -> Option<Value<'frame, 'static>>

Returns the instance if this type is a singleton.

pub fn n_initialized(self) -> i32

Returns the number of initialized fields.

pub fn hash(self) -> u32

Returns the hash of this type.

pub fn is_abstract(self) -> bool

Returns true if this is an abstract type.

pub fn mutable(self) -> bool

Returns true if this is a mutable type.

pub fn has_free_type_vars(self) -> bool

Returns true if one or more of the type parameters has not been set.

pub fn is_concrete_type(self) -> bool

Returns true if this type can have instances

pub fn is_dispatch_tuple(self) -> bool

Returns true if this type is a dispatch, or leaf, tuple type.

pub fn zeroinit(self) -> bool

Returns true if one or more fields require zero-initialization.

pub fn has_concrete_subtype(self) -> bool

If false, no value will have this type.

pub fn as_value(self) -> Value<'frame, 'static>

Convert self to a Value. Convert self to a Value.

pub fn instantiate<'fr, 'value, 'borrow, F, V>(
    self,
    frame: &mut F,
    values: V
) -> JlrsResult<Value<'fr, 'borrow>> where
    F: Frame<'fr>,
    V: AsMut<[Value<'value, 'borrow>]>, 

Intantiate this DataType with the given values. The type must be concrete. One free slot on the GC stack is required for this function to succeed, returns an error if no slot is available or if the type is not concrete.

pub fn instantiate_output<'output, 'fr, 'value, 'borrow, F, V>(
    self,
    frame: &mut F,
    output: Output<'output>,
    values: V
) -> JlrsResult<Value<'output, 'borrow>> where
    F: Frame<'fr>,
    V: AsMut<[Value<'value, 'borrow>]>, 

Intantiate this DataType with the given values using the given output. The type must be concrete, returns an error if the type is not concrete.

impl<'base> DataType<'base>

pub fn typeofbottom_type(_: Global<'base>) -> Self

The type of the bottom type, Union{}.

pub fn datatype_type(_: Global<'base>) -> Self

The type DataType.

pub fn uniontype_type(_: Global<'base>) -> Self

The type Union.

pub fn unionall_type(_: Global<'base>) -> Self

The type UnionAll.

pub fn tvar_type(_: Global<'base>) -> Self

The type TypeVar.

pub fn any_type(_: Global<'base>) -> Self

The type Any.

pub fn typename_type(_: Global<'base>) -> Self

The type TypeName.

pub fn symbol_type(_: Global<'base>) -> Self

The type Symbol.

pub fn ssavalue_type(_: Global<'base>) -> Self

The type Core.SSAValue.

pub fn abstractslot_type(_: Global<'base>) -> Self

The type Slot.

pub fn slotnumber_type(_: Global<'base>) -> Self

The type SlotNumber.

pub fn typedslot_type(_: Global<'base>) -> Self

The type TypedSlot.

pub fn simplevector_type(_: Global<'base>) -> Self

The type SimpleVector, or SVec.

pub fn anytuple_type(_: Global<'base>) -> Self

The type Tuple.

pub fn tuple_type(_: Global<'base>) -> Self

The type Tuple.

pub fn emptytuple_type(_: Global<'base>) -> Self

The type of an empty tuple.

pub fn function_type(_: Global<'base>) -> Self

The type Function.

pub fn builtin_type(_: Global<'base>) -> Self

The type Builtin.

pub fn method_instance_type(_: Global<'base>) -> Self

The type MethodInstance.

pub fn code_instance_type(_: Global<'base>) -> Self

The type CodeInstance.

pub fn code_info_type(_: Global<'base>) -> Self

The type CodeInfo.

pub fn method_type(_: Global<'base>) -> Self

The type Method.

pub fn module_type(_: Global<'base>) -> Self

The type Module.

pub fn weakref_type(_: Global<'base>) -> Self

The type WeakRef.

pub fn abstractstring_type(_: Global<'base>) -> Self

The type AbstractString.

pub fn string_type(_: Global<'base>) -> Self

The type String.

pub fn errorexception_type(_: Global<'base>) -> Self

The type ErrorException.

pub fn argumenterror_type(_: Global<'base>) -> Self

The type ArgumentError.

pub fn loaderror_type(_: Global<'base>) -> Self

The type LoadError.

pub fn initerror_type(_: Global<'base>) -> Self

The type InitError.

pub fn typeerror_type(_: Global<'base>) -> Self

The type TypeError.

pub fn methoderror_type(_: Global<'base>) -> Self

The type MethodError.

pub fn undefvarerror_type(_: Global<'base>) -> Self

The type UndefVarError.

pub fn lineinfonode_type(_: Global<'base>) -> Self

The type LineInfoNode.

pub fn boundserror_type(_: Global<'base>) -> Self

The type BoundsError.

pub fn bool_type(_: Global<'base>) -> Self

The type Bool.

pub fn char_type(_: Global<'base>) -> Self

The type Char.

pub fn int8_type(_: Global<'base>) -> Self

The type Int8.

pub fn uint8_type(_: Global<'base>) -> Self

The type UInt8.

pub fn int16_type(_: Global<'base>) -> Self

The type Int16.

pub fn uint16_type(_: Global<'base>) -> Self

The type UInt16.

pub fn int32_type(_: Global<'base>) -> Self

The type Int32.

pub fn uint32_type(_: Global<'base>) -> Self

The type UInt32.

pub fn int64_type(_: Global<'base>) -> Self

The type Int64.

pub fn uint64_type(_: Global<'base>) -> Self

The type UInt64.

pub fn float16_type(_: Global<'base>) -> Self

The type Float16.

pub fn float32_type(_: Global<'base>) -> Self

The type Float32.

pub fn float64_type(_: Global<'base>) -> Self

The type Float64.

pub fn floatingpoint_type(_: Global<'base>) -> Self

The type AbstractFloat.

pub fn number_type(_: Global<'base>) -> Self

The type Number.

pub fn nothing_type(_: Global<'base>) -> Self

The type Nothing.

pub fn signed_type(_: Global<'base>) -> Self

The type Signed.

pub fn voidpointer_type(_: Global<'base>) -> Self

The type Ptr{Nothing}.

pub fn task_type(_: Global<'base>) -> Self

The type Task.

pub fn expr_type(_: Global<'base>) -> Self

The type Expr.

pub fn globalref_type(_: Global<'base>) -> Self

The type GlobalRef.

pub fn linenumbernode_type(_: Global<'base>) -> Self

The type LineNumberNode.

pub fn gotonode_type(_: Global<'base>) -> Self

The type GotoNode.

pub fn phinode_type(_: Global<'base>) -> Self

The type PhiNode.

pub fn pinode_type(_: Global<'base>) -> Self

The type PiNode.

pub fn phicnode_type(_: Global<'base>) -> Self

The type PhiCNode.

pub fn upsilonnode_type(_: Global<'base>) -> Self

The type UpsilonNode.

pub fn quotenode_type(_: Global<'base>) -> Self

The type QuoteNode.

pub fn newvarnode_type(_: Global<'base>) -> Self

The type NewVarNode.

pub fn intrinsic_type(_: Global<'base>) -> Self

The type Intrinsic.

pub fn methtable_type(_: Global<'base>) -> Self

The type MethodTable.

pub fn typemap_level_type(_: Global<'base>) -> Self

The type TypeMapLevel.

pub fn typemap_entry_type(_: Global<'base>) -> Self

The type TypeMapEntry.

Trait Implementations

impl<'frame, 'data> Cast<'frame, 'data> for DataType<'frame>

type Output = Self

fn cast(value: Value<'frame, 'data>) -> JlrsResult<Self::Output>

unsafe fn cast_unchecked(value: Value<'frame, 'data>) -> Self::Output

impl<'frame> Clone for DataType<'frame>

fn clone(&self) -> DataType<'frame>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'frame> Copy for DataType<'frame>

impl<'frame, 'data> Debug for DataType<'frame>

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

Formats the value using the given formatter.

impl<'frame> Eq for DataType<'frame>

impl<'frame> Hash for DataType<'frame>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'frame> Into<Value<'frame, 'static>> for DataType<'frame>

fn into(self) -> Value<'frame, 'static>

Performs the conversion.

impl<'frame> JuliaType for DataType<'frame>

unsafe fn julia_type() -> *mut jl_datatype_t

impl<'frame> JuliaTypecheck for DataType<'frame>

unsafe fn julia_typecheck(t: DataType<'_>) -> bool

impl<'frame> PartialEq<DataType<'frame>> for DataType<'frame>

fn eq(&self, other: &DataType<'frame>) -> bool

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

fn ne(&self, other: &DataType<'frame>) -> bool

This method tests for !=.

impl<'frame> StructuralEq for DataType<'frame>

impl<'frame> StructuralPartialEq for DataType<'frame>

impl<'frame> ValidLayout for DataType<'frame>

unsafe fn valid_layout(v: Value<'_, '_>) -> bool