Struct goblin::strtab::Strtab

pub struct Strtab<'a> { /* fields omitted */ }

A common string table format which is indexed by byte offsets (and not member index). Constructed using parse with your choice of delimiter. Please be careful.

Implementations

impl<'a> Strtab<'a>

pub fn new(bytes: &'a [u8], delim: u8) -> Self

Construct a new strtab with bytes as the backing string table, using delim as the delimiter between entries

pub unsafe fn from_raw(ptr: *const u8, size: usize, delim: u8) -> Strtab<'a>

Construct a strtab from a ptr, and a size, using delim as the delimiter

Safety

This function creates a Strtab directly from a raw pointer and size

pub fn parse(
    bytes: &'a [u8],
    offset: usize,
    len: usize,
    delim: u8
) -> Result<Strtab<'a>>

Parses a strtab from bytes at offset with len size as the backing string table, using delim as the delimiter

pub fn to_vec(&self) -> Result<Vec<&'a str>>

Converts the string table to a vector, with the original delim used to separate the strings

pub fn get(&self, offset: usize) -> Option<Result<&'a str>>

Safely parses and gets a str reference from the backing bytes starting at byte offset. If the index is out of bounds, None is returned. Requires feature = "alloc"

pub fn get_unsafe(&self, offset: usize) -> Option<&'a str>

Gets a str reference from the backing bytes starting at byte offset. If the index is out of bounds, None is returned. Panics if bytes are invalid UTF-8.

Trait Implementations

impl<'a> Debug for Strtab<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Strtab<'a>

fn default() -> Strtab<'a>

Returns the "default value" for a type.

impl<'a> Index<usize> for Strtab<'a>

type Output = str

The returned type after indexing.

fn index(&self, offset: usize) -> &Self::Output

Gets str reference at starting at byte offset. NB: this will panic if the underlying bytes are not valid utf8, or the offset is invalid