Skip to main content

StringTable

Struct StringTable 

Source
pub struct StringTable { /* private fields */ }
Expand description

A string table containing key-value pairs.

String tables store game data in a table format where each row has a key (string) and optional value (binary data). They’re used for various purposes like tracking active modifiers, entity names, particle systems, etc.

§Usage Patterns

§Accessing player data

use source2_demo::prelude::*;
use source2_demo::proto::CMsgPlayerInfo;

let userinfo = ctx.string_tables().get_by_name("userinfo")?;
let row = userinfo.get_row_by_index(0)?;

if let Some(data) = row.value() {
    let player_info = CMsgPlayerInfo::decode(data)?;
    println!("Player: {}", player_info.name());
}

§Listing all entries

use source2_demo::prelude::*;

for row in table.iter() {
    println!("Key: {}", row.key());
    if let Some(value) = row.value() {
        println!("  Value size: {} bytes", value.len());
    }
}

Implementations§

Source§

impl StringTable

Source

pub fn index(&self) -> i32

Returns the table’s numeric index.

Source

pub fn name(&self) -> &str

Returns the table’s name.

Source

pub fn iter(&self) -> impl Iterator<Item = &StringTableRow>

Returns an iterator over all rows in the string table.

This allows you to inspect all key-value pairs stored in the table.

§Examples
use source2_demo::prelude::*;

let table = ctx.string_tables().get_by_name("ActiveModifiers")?;

for row in table.iter() {
    println!("Key: {}", row.key());
    if let Some(value) = row.value() {
        println!("  Value size: {} bytes", value.len());
    }
}
Source

pub fn get_row_by_index( &self, idx: usize, ) -> Result<&StringTableRow, StringTableError>

Gets a specific row by its index in the string table.

Each string table is essentially a list of key-value pairs. This retrieves the row at the specified position.

§Arguments
  • idx - The row index (0-based)
§Errors

Returns StringTableError::RowNotFoundByIndex if the index is out of bounds.

§Examples
use source2_demo::prelude::*;

let userinfo = ctx.string_tables().get_by_name("userinfo")?;

// Get player info at slot 0
let row = userinfo.get_row_by_index(0)?;
println!("Slot 0 key: {}", row.key());

Trait Implementations§

Source§

impl Clone for StringTable

Source§

fn clone(&self) -> StringTable

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for StringTable

Source§

fn default() -> StringTable

Returns the “default value” for a type. Read more
Source§

impl Display for StringTable

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.