BinaryNinja::SimilarityResult Struct Reference

A match produced by a provider. More...

Detailed Description

A match produced by a provider.

Similarity and confidence range from 0 to 255, where 255 is strongest. Automatic metadata transfer requires `target` to identify an active function.

Public Member Functions
	SimilarityResult (SimilarityProviderId provider, uint8_t similarity, uint8_t confidence, const SimilarityEntityRef &target)
	SimilarityResult (const BNSimilarityResult &result)
bool	operator== (const SimilarityResult &other) const =default
BNSimilarityResult	ToRaw () const

Public Attributes
SimilarityProviderId	providerId
	The provider which produced the match.
uint8_t	similarity
	The similarity of the two entities.
uint8_t	confidence
	The provider's confidence in the match.
SimilarityEntityRef	target
	The matched entity, which may be used as the source for metadata transfer.

Constructor & Destructor Documentation

SimilarityResult() [1/2]

BinaryNinja::SimilarityResult::SimilarityResult ( SimilarityProviderId provider, uint8_t similarity, uint8_t confidence, const SimilarityEntityRef & target )

inline

SimilarityResult() [2/2]

BinaryNinja::SimilarityResult::SimilarityResult ( const BNSimilarityResult & result )

inline

Member Function Documentation

operator==()

bool BinaryNinja::SimilarityResult::operator== ( const SimilarityResult & other ) const

default

ToRaw()

BNSimilarityResult BinaryNinja::SimilarityResult::ToRaw ( ) const

inlinenodiscard

Member Data Documentation

providerId

SimilarityProviderId BinaryNinja::SimilarityResult::providerId

The provider which produced the match.

similarity

uint8_t BinaryNinja::SimilarityResult::similarity

The similarity of the two entities.

confidence

uint8_t BinaryNinja::SimilarityResult::confidence

The provider's confidence in the match.

target

SimilarityEntityRef BinaryNinja::SimilarityResult::target

The matched entity, which may be used as the source for metadata transfer.