Struct sway_ir::irtype::Type

pub struct Type(pub DefaultKey);

Tuple Fields

0: DefaultKey

Implementations

impl Type

pub fn get_type(context: &Context<'_>, t: &TypeContent) -> Option<Type>

Get Type if it already exists.

pub fn create_basic_types(context: &mut Context<'_>)

pub fn get_content<'a>(&self, context: &'a Context<'_>) -> &'a TypeContent

Get the content for this Type.

pub fn get_never(context: &Context<'_>) -> Type

Get never type

pub fn get_unit(context: &Context<'_>) -> Type

Get unit type

pub fn get_bool(context: &Context<'_>) -> Type

Get bool type

pub fn new_uint(context: &mut Context<'_>, width: u16) -> Type

New unsigned integer type

pub fn get_uint8(context: &Context<'_>) -> Type

New u8 type

pub fn get_uint16(context: &Context<'_>) -> Type

New u16 type

pub fn get_uint32(context: &Context<'_>) -> Type

New u32 type

pub fn get_uint64(context: &Context<'_>) -> Type

New u64 type

pub fn get_uint256(context: &Context<'_>) -> Type

New u64 type

pub fn get_uint(context: &Context<'_>, width: u16) -> Option<Type>

Get unsigned integer type

pub fn get_b256(context: &Context<'_>) -> Type

Get B256 type

pub fn new_string_array(context: &mut Context<'_>, len: u64) -> Type

Get string type

pub fn new_array(context: &mut Context<'_>, elm_ty: Type, len: u64) -> Type

Get array type

pub fn new_union(context: &mut Context<'_>, fields: Vec<Type>) -> Type

Get union type

pub fn new_struct(context: &mut Context<'_>, fields: Vec<Type>) -> Type

Get struct type

pub fn new_ptr(context: &mut Context<'_>, to_ty: Type) -> Type

New pointer type

pub fn get_slice(context: &Context<'_>) -> Type

Get slice type

pub fn get_typed_slice(context: &mut Context<'_>, item_ty: Type) -> Type

Get typed slice type

pub fn as_string(&self, context: &Context<'_>) -> String

Return a string representation of type, used for printing.

pub fn eq(&self, context: &Context<'_>, other: &Type) -> bool

Compare a type to this one for equivalence. PartialEq does not take into account the special case for Unions below.

pub fn is_never(&self, context: &Context<'_>) -> bool

Is Never type

pub fn is_bool(&self, context: &Context<'_>) -> bool

Is bool type

pub fn is_unit(&self, context: &Context<'_>) -> bool

Is unit type

pub fn is_uint(&self, context: &Context<'_>) -> bool

Is unsigned integer type

pub fn is_uint8(&self, context: &Context<'_>) -> bool

Is u8 type

pub fn is_uint32(&self, context: &Context<'_>) -> bool

Is u32 type

pub fn is_uint64(&self, context: &Context<'_>) -> bool

Is u64 type

pub fn is_uint_of(&self, context: &Context<'_>, width: u16) -> bool

Is unsigned integer type of specific width

pub fn is_b256(&self, context: &Context<'_>) -> bool

Is B256 type

pub fn is_string_slice(&self, context: &Context<'_>) -> bool

Is string type

pub fn is_string_array(&self, context: &Context<'_>) -> bool

Is string type

pub fn is_array(&self, context: &Context<'_>) -> bool

Is array type

pub fn is_union(&self, context: &Context<'_>) -> bool

Is union type

pub fn is_struct(&self, context: &Context<'_>) -> bool

Is struct type

pub fn is_enum(&self, context: &Context<'_>) -> bool

Is enum type

pub fn is_aggregate(&self, context: &Context<'_>) -> bool

Is aggregate type: struct, union, enum or array.

pub fn is_slice(&self, context: &Context<'_>) -> bool

Returns true if self is a slice type.

pub fn is_ptr(&self, context: &Context<'_>) -> bool

Returns true if self is a pointer type.

pub fn get_pointee_type(&self, context: &Context<'_>) -> Option<Type>

Get pointed to type iff `self`` is a pointer.

pub fn get_uint_width(&self, context: &Context<'_>) -> Option<u16>

Get width of an integer type.

pub fn get_indexed_type( &self, context: &Context<'_>, indices: &[u64], ) -> Option<Type>

What’s the type of the struct/array value indexed by indices.

pub fn get_indexed_offset( &self, context: &Context<'_>, indices: &[u64], ) -> Option<u64>

What’s the offset, in bytes, of the indexed element? Returns None on invalid indices. Panics if self is not an aggregate (struct, union, or array).

pub fn get_value_indexed_offset( &self, context: &Context<'_>, indices: &[Value], ) -> Option<u64>

What’s the offset, in bytes, of the value indexed element? It may not always be possible to determine statically.

pub fn get_field_type(&self, context: &Context<'_>, idx: u64) -> Option<Type>

pub fn get_array_elem_type(&self, context: &Context<'_>) -> Option<Type>

Get the type of the array element, if applicable.

pub fn get_typed_slice_elem_type(&self, context: &Context<'_>) -> Option<Type>

Get the type of the array element, if applicable.

pub fn get_array_len(&self, context: &Context<'_>) -> Option<u64>

Get the length of the array , if applicable.

pub fn get_string_len(&self, context: &Context<'_>) -> Option<u64>

Get the length of a string.

pub fn get_field_types(&self, context: &Context<'_>) -> Vec<Type>

Get the type of each field of a struct Type. Empty vector otherwise.

pub fn get_struct_field_offset_and_type( &self, context: &Context<'_>, field_idx: u64, ) -> Option<(u64, Type)>

Get the offset, in bytes, and the Type of the struct field at the index field_idx, if self is a struct, otherwise None. Panics if the field_idx is out of bounds.

pub fn get_union_field_offset_and_type( &self, context: &Context<'_>, field_idx: u64, ) -> Option<(u64, Type)>

Get the offset, in bytes, and the Type of the union field at the index field_idx, if self is a union, otherwise None. Panics if the field_idx is out of bounds.

pub fn size(&self, context: &Context<'_>) -> TypeSize

Returns the memory size of the Type. The returned TypeSize::in_bytes will provide the raw memory size of the self, when it’s not embedded in an aggregate.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl DebugWithContext for Type

fn fmt_with_context( &self, formatter: &mut Formatter<'_>, context: &Context<'_>, ) -> Result

fn with_context<'a, 'c, 'eng>( &'a self, context: &'c Context<'eng>, ) -> WithContext<'a, 'c, 'eng, Self>

impl Hash for Type

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Type

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

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

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 Copy for Type

impl Eq for Type

impl StructuralPartialEq for Type