Enum InstructionTextTokenKind 

pub enum InstructionTextTokenKind {
    Text,
    Instruction,
    OperandSeparator,
    Register,
    Integer {
        value: u64,
        size: Option<usize>,
        operand: Option<usize>,
    },
    PossibleAddress {
        value: u64,
        size: Option<usize>,
        operand: Option<usize>,
    },
    BeginMemoryOperand,
    EndMemoryOperand,
    FloatingPoint {
        value: f64,
        size: Option<usize>,
    },
    Annotation,
    CodeRelativeAddress {
        value: u64,
        size: Option<usize>,
        operand: Option<usize>,
    },
    ArgumentName {
        value: u64,
    },
    HexDumpByteValue {
        value: u8,
    },
    HexDumpSkippedByte,
    HexDumpInvalidByte,
    HexDumpText {
        width: u64,
    },
    Opcode,
    String {
        value: u64,
    },
    StringContent {
        ty: StringType,
    },
    CharacterConstant {
        operand: Option<usize>,
    },
    Keyword {
        value: u64,
    },
    TypeName,
    FieldName {
        offset: u64,
        type_names: Vec<String>,
    },
    NameSpace,
    NameSpaceSeparator,
    Tag,
    StructOffset {
        offset: u64,
        type_names: Vec<String>,
    },
    StructOffsetByteValue,
    StructureHexDumpText {
        width: u64,
    },
    GotoLabel {
        target: u64,
    },
    Comment {
        target: u64,
    },
    PossibleValue {
        value: u64,
    },
    PossibleValueType,
    ArrayIndex {
        index: u64,
    },
    Indentation,
    UnknownMemory,
    EnumerationMember {
        value: u64,
        type_id: Option<String>,
    },
    Operation,
    BaseStructureName,
    BaseStructureSeparator,
    Brace {
        hash: Option<u64>,
    },
    ValueLocation,
    CodeSymbol {
        value: u64,
        size: usize,
    },
    DataSymbol {
        value: u64,
        size: usize,
    },
    LocalVariable {
        variable_id: u64,
        ssa_version: usize,
    },
    Import {
        target: u64,
    },
    AddressDisplay {
        address: u64,
    },
    IndirectImport {
        target: u64,
        size: usize,
        source_operand: usize,
    },
    ExternalSymbol {
        value: u64,
    },
    StackVariable {
        variable_id: u64,
    },
    AddressSeparator,
    CollapsedInformation,
    CollapseStateIndicator {
        hash: Option<u64>,
    },
    NewLine {
        value: u64,
    },
}

Variants

Text

Instruction

OperandSeparator

Separator between operands, such as , or +.

This is primarily used to identify the tokens associated with a given operand.

Register

Integer

Fields

value: u64

size: Option<usize>

Size of the integer

operand: Option<usize>

The operand this integer is associated with.

This is primarily used to change the display type of the integer.

NOTE: This will be populated by a post-processing step when rendering, so you can leave this as None when emitting in Architecture::instruction_text and other similar methods.

PossibleAddress

Fields

value: u64

size: Option<usize>

Size of the address

operand: Option<usize>

The operand this integer is associated with.

This is primarily used to change the display type of the integer.

NOTE: This will be populated by a post-processing step when rendering, so you can leave this as None when emitting in Architecture::instruction_text and other similar methods.

BeginMemoryOperand

EndMemoryOperand

FloatingPoint

Fields

value: f64

size: Option<usize>

Size of the floating point

Annotation

CodeRelativeAddress

Fields

value: u64

size: Option<usize>

Size of the address

operand: Option<usize>

The operand this integer is associated with.

This is primarily used to change the display type of the integer.

NOTE: This will be populated by a post-processing step when rendering, so you can leave this as None when emitting in Architecture::instruction_text and other similar methods.

ArgumentName

Fields

value: u64

HexDumpByteValue

Fields

value: u8

HexDumpSkippedByte

HexDumpInvalidByte

HexDumpText

Fields

width: u64

Opcode

String

Fields

value: u64

StringContent

String content is only present for:

• InstructionTextTokenContext::StringReference
• InstructionTextTokenContext::StringDisplay

Fields

ty: StringType

CharacterConstant

Fields

operand: Option<usize>

The operand this character is associated with.

This is primarily used to change the display type of the character.

NOTE: This will be populated by a post-processing step when rendering, so you can leave this as None when emitting in Architecture::instruction_text and other similar methods.

Keyword

Fields

value: u64

TypeName

FieldName

Fields

offset: u64

Offset to this field in the respective structure

type_names: Vec<String>

Stores the type names for the referenced field name.

This is typically just the members name. For example MyStructure.my_field will have type_names be [“my_field”].

NameSpace

NameSpaceSeparator

Tag

StructOffset

Fields

offset: u64

Offset to this field in the respective structure

type_names: Vec<String>

Stores the type names for the referenced field name.

StructOffsetByteValue

StructureHexDumpText

Fields

width: u64

GotoLabel

Fields

target: u64

Comment

Fields

target: u64

PossibleValue

Fields

value: u64

PossibleValueType

ArrayIndex

Fields

index: u64

Indentation

UnknownMemory

EnumerationMember

Fields

value: u64

type_id: Option<String>

The enumerations type id

Operation

Operations like +, -, %

BaseStructureName

BaseStructureSeparator

Brace

Fields

hash: Option<u64>

ValueLocation

CodeSymbol

Fields

value: u64

size: usize

DataSymbol

Fields

value: u64

size: usize

LocalVariable

Fields

variable_id: u64

ssa_version: usize

NOTE: This is only valid in SSA form

Import

Fields

target: u64

AddressDisplay

Fields

address: u64

IndirectImport

Fields

target: u64

The address of the import

If you want the address of the import token use InstructionTextToken::address instead.

size: usize

Size of the instruction this token is apart of

source_operand: usize

ExternalSymbol

Fields

value: u64

StackVariable

Fields

variable_id: u64

AddressSeparator

CollapsedInformation

CollapseStateIndicator

Fields

hash: Option<u64>

NewLine

Fields

value: u64

Trait Implementations

impl Clone for InstructionTextTokenKind

fn clone(&self) -> InstructionTextTokenKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstructionTextTokenKind

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

Formats the value using the given formatter.

impl From<InstructionTextTokenKind> for BNInstructionTextTokenType

fn from(value: InstructionTextTokenKind) -> Self

Converts to this type from the input type.

impl PartialEq for InstructionTextTokenKind

fn eq(&self, other: &InstructionTextTokenKind) -> 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 Eq for InstructionTextTokenKind

impl StructuralPartialEq for InstructionTextTokenKind