Struct StringLiteral 

pub struct StringLiteral<'db> { /* private fields */ }

A borrowed view of one string IDA located, keyed by address.

Carries the address, octet len, and decoded text. The raw type fields are read once at iteration; the text is decoded on demand.

Implementations

impl<'db> StringLiteral<'db>

pub const fn address(&self) -> Address

The string’s address.

pub const fn len(&self) -> usize

The string’s length in octets (raw bytes), excluding any terminator. Divide by char_width for a character count.

pub const fn is_empty(&self) -> bool

Whether the string is empty.

pub fn char_width(&self) -> u8

Bytes per character: 1 (byte / UTF-8), 2 (UTF-16), or 4 (UTF-32).

pub fn is_pascal(&self) -> bool

Whether the string is length-prefixed (Pascal-style) rather than terminated.

pub fn text(&self) -> Option<String>

The decoded string as UTF-8, or None if the bytes can’t be read.

This is the semantic form, for search, matching, and analysis: undecodable units become the Unicode replacement character (U+FFFD) rather than failing. For the pseudocode-faithful rendering with control bytes shown as C escapes, use escaped.

pub fn escaped(&self) -> Option<String>

The string in its C-escaped display form, or None if the bytes can’t be read.

This is what the decompiler renders in pseudocode: non-printable and undecodable bytes show as C escapes (\n, \xNN, \uNNNN). Use text for the semantic form.

Trait Implementations

impl<'db> Clone for StringLiteral<'db>

fn clone(&self) -> StringLiteral<'db>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'db> Copy for StringLiteral<'db>

impl Debug for StringLiteral<'_>

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

Formats the value using the given formatter.

impl Eq for StringLiteral<'_>

impl Hash for StringLiteral<'_>

fn hash<H: Hasher>(&self, s: &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 Ord for StringLiteral<'_>

fn cmp(&self, o: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StringLiteral<'_>

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StringLiteral<'_>

fn partial_cmp(&self, o: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.