Struct Component

pub struct Component { /* private fields */ }

Components are objects that can contain Functions, Data Variables, and other Components.

They can be queried for information about the items contained within them.

Components have a Guid, which persistent across saves and loads of the database, and should be used for retrieving components when such is required and a reference to the Component cannot be held.

Implementations

impl Component

pub fn guid(&self) -> String

pub fn add_function(&self, func: &Function) -> bool

Add function to this component.

pub fn contains_function(&self, func: &Function) -> bool

Check whether this component contains a function.

pub fn remove_function(&self, func: &Function) -> bool

Remove function from this component.

pub fn add_component(&self, component: &Component) -> bool

Move component to this component. This will remove it from the old parent.

pub fn contains_component(&self, component: &Component) -> bool

Check whether this component contains a component.

pub fn remove_component(&self, component: &Component) -> bool

Remove a component from the current component, moving it to the root.

This function has no effect when used from the root component. Use BinaryView.remove_component to Remove a component from the tree entirely.

pub fn add_data_variable(&self, data_variable: &DataVariable) -> bool

Add data variable to this component.

pub fn contains_data_variable(&self, data_variable: &DataVariable) -> bool

Check whether this component contains a data variable.

pub fn remove_data_variable(&self, data_variable: &DataVariable) -> bool

Remove data variable from this component.

pub fn display_name(&self) -> String

Original name of the component

pub fn name(&self) -> String

Original name set for this component :note: The .display_name property should be used for bv.get_component_by_path() lookups. This can differ from the .display_name property if one of its sibling components has the same .original_name; In that case, .name will be an automatically generated unique name (e.g. “MyComponentName (1)”) while .original_name will remain what was originally set (e.g. “MyComponentName”) If this component has a duplicate name and is moved to a component where none of its siblings share its name, .name will return the original “MyComponentName”

pub fn set_name(&self, name: &str)

pub fn parent(&self) -> Option<Ref<Component>>

The component that contains this component, if it exists.

pub fn view(&self) -> Option<Ref<BinaryView>>

pub fn components(&self) -> Array<Component>

Is an iterator for all Components contained within this Component

pub fn functions(&self) -> Array<Function>

List of all Functions contained within this Component

pub fn data_variables(&self) -> Array<DataVariable>

List of all Data Variables contained within this Component

pub fn referenced_data_variables(&self, recursive: bool) -> Array<DataVariable>

Get data variables referenced by this component

• recursive - Get all DataVariables referenced by this component and subcomponents.

pub fn referenced_types( &self, recursive: bool, ) -> Array<ComponentReferencedType>

Get Types referenced by this component

• recursive - Get all Types referenced by this component and subcomponents.

pub fn remove_all_functions(&self)

pub fn add_all_members_from(&self, component: &Component)

Trait Implementations

impl CoreArrayProvider for Component

type Raw = *mut BNComponent

type Context = ()

type Wrapped<'a> = Guard<'a, Component>

impl Debug for Component

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

Formats the value using the given formatter.

impl PartialEq for Component

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

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

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

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

impl ToOwned for Component

type Owned = Ref<Component>

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 Component