Struct TypeContainer

#[repr(transparent)]
pub struct TypeContainer {
    pub handle: NonNull<BNTypeContainer>,
}

A TypeContainer is a generic interface to access various Binary Ninja models that contain types. Types are stored with both a unique id and a unique name.

Fields

handle: NonNull<BNTypeContainer>

Implementations

impl TypeContainer

pub fn id(&self) -> BnString

Get an id string for the Type Container. This will be unique within a given analysis session, but may not be globally unique.

pub fn name(&self) -> BnString

Get a user-friendly name for the Type Container.

pub fn container_type(&self) -> TypeContainerType

Get the type of underlying model the Type Container is accessing.

pub fn is_mutable(&self) -> bool

If the Type Container supports mutable operations (add, rename, delete)

pub fn platform(&self) -> Ref<Platform>

Get the Platform object associated with this Type Container. All Type Containers have exactly one associated Platform (as opposed to, e.g. Type Libraries).

pub fn add_types<I, T>(&self, types: I) -> bool

where I: IntoIterator<Item = T>, T: Into<QualifiedNameAndType>,

Add or update types to a Type Container. If the Type Container already contains a type with the same name as a type being added, the existing type will be replaced with the definition given to this function, and references will be updated in the source model.

pub fn add_types_with_progress<I, T, P>(&self, types: I, progress: P) -> bool

where I: IntoIterator<Item = T>, T: Into<QualifiedNameAndType>, P: ProgressCallback,

pub fn rename_type<T: Into<QualifiedName>, S: BnStrCompatible>( &self, name: T, type_id: S, ) -> bool

Rename a type in the Type Container. All references to this type will be updated (by id) to use the new name.

Returns true if the type was renamed.

pub fn delete_type<S: BnStrCompatible>(&self, type_id: S) -> bool

Delete a type in the Type Container. Behavior of references to this type is not specified and you may end up with broken references if any still exist.

Returns true if the type was deleted.

pub fn type_id<T: Into<QualifiedName>>(&self, name: T) -> Option<BnString>

Get the unique id of the type in the Type Container with the given name.

If no type with that name exists, returns None.

pub fn type_name<S: BnStrCompatible>(&self, type_id: S) -> Option<QualifiedName>

Get the unique name of the type in the Type Container with the given id.

If no type with that id exists, returns None.

pub fn type_by_id<S: BnStrCompatible>(&self, type_id: S) -> Option<Ref<Type>>

Get the definition of the type in the Type Container with the given id.

If no type with that id exists, returns None.

pub fn type_by_name<T: Into<QualifiedName>>(&self, name: T) -> Option<Ref<Type>>

Get the definition of the type in the Type Container with the given name.

If no type with that name exists, returns None.

pub fn types(&self) -> Option<HashMap<String, (QualifiedName, Ref<Type>)>>

Get a mapping of all types in a Type Container.

pub fn type_ids(&self) -> Option<Array<BnString>>

Get all type ids in a Type Container.

pub fn type_names(&self) -> Option<Array<QualifiedName>>

Get all type names in a Type Container.

pub fn type_names_and_ids( &self, ) -> Option<(Array<BnString>, Array<QualifiedName>)>

Get a mapping of all type ids and type names in a Type Container.

pub fn parse_type_string<S: BnStrCompatible>( &self, source: S, import_dependencies: bool, ) -> Result<QualifiedNameAndType, Array<TypeParserError>>

Parse a single type and name from a string containing their definition, with knowledge of the types in the Type Container.

• source - Source code to parse
• import_dependencies - If Type Library / Type Archive types should be imported during parsing

pub fn parse_types_from_source<S, F, O, D, A>( &self, source: S, filename: F, options: O, include_directories: D, auto_type_source: A, import_dependencies: bool, ) -> Result<TypeParserResult, Array<TypeParserError>>

where S: BnStrCompatible, F: BnStrCompatible, O: IntoIterator, O::Item: BnStrCompatible, D: IntoIterator, D::Item: BnStrCompatible, A: BnStrCompatible,

Parse an entire block of source into types, variables, and functions, with knowledge of the types in the Type Container.

• source - Source code to parse
• file_name - Name of the file containing the source (optional: exists on disk)
• options - String arguments to pass as options, e.g. command line arguments
• include_dirs - List of directories to include in the header search path
• auto_type_source - Source of types if used for automatically generated types
• import_dependencies - If Type Library / Type Archive types should be imported during parsing

Trait Implementations

impl Clone for TypeContainer

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeContainer

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

Formats the value using the given formatter.

impl Drop for TypeContainer

fn drop(&mut self)

Executes the destructor for this type.