Struct Type 

#[repr(transparent)]
pub struct Type {
    pub handle: *mut BNType,
}

The core model for types in Binary Ninja.

A Type is how we model the storage of a Variable or crate::variable::DataVariable as well as propagate information such as the constness of a variable. Types are also used to declare function signatures, such as the FunctionParameter’s and return type.

Types are immutable. To change a type, you must create a new one either using TypeBuilder or one of the helper functions:

• Type::void
• Type::bool
• Type::char
• Type::wide_char
• Type::int, Type::named_int
• Type::float, Type::named_float
• Type::array
• Type::enumeration
• Type::structure
• Type::named_type, Type::named_type_from_type
• Type::function, Type::function_with_opts
• Type::pointer, Type::const_pointer, Type::pointer_of_width, Type::pointer_with_options

Example

As an example, defining a named type within a BinaryView:

let bv = binaryninja::load("example.bin").unwrap();
let my_custom_type_1 = Type::named_int(5, false, "my_w");
let my_custom_type_2 = Type::int(5, false);
bv.define_user_type("int_1", &my_custom_type_1);
bv.define_user_type("int_2", &my_custom_type_2);

Fields

handle: *mut BNType

Implementations

impl Type

pub unsafe fn from_raw(handle: *mut BNType) -> Self

pub unsafe fn ref_from_raw(handle: *mut BNType) -> Ref<Self>

pub fn to_builder(&self) -> TypeBuilder

pub fn type_class(&self) -> TypeClass

pub fn width(&self) -> u64

The size of the type in bytes.

pub fn alignment(&self) -> usize

pub fn is_signed(&self) -> Conf<bool>

pub fn is_const(&self) -> Conf<bool>

pub fn is_volatile(&self) -> Conf<bool>

pub fn is_floating_point(&self) -> bool

pub fn child_type(&self) -> Option<Conf<Ref<Type>>>

pub fn target(&self) -> Option<Conf<Ref<Type>>>

This is an alias for Self::child_type.

pub fn element_type(&self) -> Option<Conf<Ref<Type>>>

This is an alias for Self::child_type.

pub fn return_value(&self) -> Option<Conf<Ref<Type>>>

This is an alias for Self::child_type.

pub fn calling_convention(&self) -> Option<Conf<Ref<CoreCallingConvention>>>

pub fn parameters(&self) -> Option<Vec<FunctionParameter>>

pub fn has_variable_arguments(&self) -> Conf<bool>

pub fn can_return(&self) -> Conf<bool>

pub fn pure(&self) -> Conf<bool>

pub fn get_structure(&self) -> Option<Ref<Structure>>

pub fn get_enumeration(&self) -> Option<Ref<Enumeration>>

pub fn get_named_type_reference(&self) -> Option<Ref<NamedTypeReference>>

pub fn count(&self) -> u64

pub fn offset(&self) -> u64

pub fn stack_adjustment(&self) -> Conf<i64>

pub fn registered_name(&self) -> Option<Ref<NamedTypeReference>>

pub fn pointer_base_type(&self) -> BNPointerBaseType

pub fn pointer_base_offset(&self) -> i64

pub fn void() -> Ref<Self>

pub fn bool() -> Ref<Self>

pub fn char() -> Ref<Self>

pub fn wide_char(width: usize) -> Ref<Self>

pub fn int(width: usize, is_signed: bool) -> Ref<Self>

pub fn named_int(width: usize, is_signed: bool, alt_name: &str) -> Ref<Self>

pub fn float(width: usize) -> Ref<Self>

pub fn named_float(width: usize, alt_name: &str) -> Ref<Self>

pub fn array<'a, T: Into<Conf<&'a Type>>>(ty: T, count: u64) -> Ref<Self>

pub fn enumeration<T: Into<Conf<bool>>>( enumeration: &Enumeration, width: NonZeroUsize, is_signed: T, ) -> Ref<Self>

NOTE

The C/C++ APIs require an associated architecture, but in the core we only query the default_int_size if the given width is 0.

For simplicity’s sake, that convention isn’t followed, and you can query Architecture::default_integer_size if you need to.

pub fn structure(structure: &Structure) -> Ref<Self>

pub fn named_type(type_reference: &NamedTypeReference) -> Ref<Self>

pub fn named_type_from_type<T: Into<QualifiedName>>( name: T, t: &Type, ) -> Ref<Self>

pub fn function<'a, T: Into<Conf<&'a Type>>>( return_type: T, parameters: Vec<FunctionParameter>, variable_arguments: bool, ) -> Ref<Self>

pub fn function_with_opts<'a, T: Into<Conf<&'a Type>>, C: Into<Conf<Ref<CoreCallingConvention>>>>( return_type: T, parameters: &[FunctionParameter], variable_arguments: bool, calling_convention: C, stack_adjust: Conf<i64>, ) -> Ref<Self>

pub fn pointer<'a, A: Architecture, T: Into<Conf<&'a Type>>>( arch: &A, ty: T, ) -> Ref<Self>

pub fn const_pointer<'a, A: Architecture, T: Into<Conf<&'a Type>>>( arch: &A, ty: T, ) -> Ref<Self>

pub fn pointer_with_options<'a, A: Architecture, T: Into<Conf<&'a Type>>>( arch: &A, ty: T, is_const: bool, is_volatile: bool, ref_type: Option<ReferenceType>, ) -> Ref<Self>

pub fn pointer_of_width<'a, T: Into<Conf<&'a Type>>>( ty: T, size: usize, is_const: bool, is_volatile: bool, ref_type: Option<ReferenceType>, ) -> Ref<Self>

pub fn generate_auto_demangled_type_id<T: Into<QualifiedName>>( name: T, ) -> String

Trait Implementations

impl CoreArrayProvider for Type

type Raw = *mut BNType

type Context = ()

type Wrapped<'a> = &'a Type

impl Debug for Type

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

Formats the value using the given formatter.

impl Display for Type

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

Formats the value using the given formatter.

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: &Self) -> 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 ToOwned for Type

type Owned = Ref<Type>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

impl Eq for Type

impl Send for Type

impl Sync for Type