StringTable Rust Reference Documentation

StringTable

Current Version: 11.6.1

Chilkat.StringTable

Store, load, search, sort, split, retrieve, and save ordered lists of strings.

Chilkat.StringTable is a simple ordered collection of strings. It can append strings directly, load one string per line from files or StringBuilder, search for substrings or wildcard matches, sort the collection, split strings into entries, retrieve strings by index, export the table as line-delimited text, and save the result to a file.

Ordered string collection

Store a list of strings in insertion order and retrieve individual entries by zero-based index.

Append and import

Add strings directly, append strings from a file, or load line-delimited text from a StringBuilder.

Search strings

Find entries containing a substring or matching a wildcard pattern when filtering or locating text values.

Sort entries

Sort the string collection when deterministic ordering or user-facing display order is needed.

Split into entries

Split delimited text into separate string-table entries for easier indexing, searching, sorting, or saving.

Export and save

Convert the table back to line-delimited text, copy it to a StringBuilder, or save the collection to a file.

Common pattern: Use StringTable when application code needs a lightweight ordered list of text values. Append or load the strings, search or sort as needed, retrieve entries by index with StringAt or StringAtSb, then export the final list as line-delimited text or save it to a file.

For an extended overview, see StringTable Class Overview.

Object Creation

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::StringTable;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let string_table = StringTable::new();
// ... the native object is freed when `string_table` goes out of scope.

pub fn new() -> StringTable

Creates the underlying native Chilkat object (StringTable also implements Default). Every method takes &self, so the object never needs to be declared mut. A StringTable is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for StringTable

The native object is freed when the StringTable is dropped — when it goes out of scope, or explicitly with drop(string_table). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<StringTable>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match string_table.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

Count

// read-only
pub fn count(&self) -> i32

Introduced in version 9.5.0.62

The number of strings in the table.

StringTable Rust Reference Documentation

StringTable

Current Version: 11.6.1

Store, load, search, sort, split, retrieve, and save ordered lists of strings.

Ordered string collection

Append and import

Search strings

Sort entries

Split into entries

Export and save

Object Creation

Errors

Properties

Count

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

VerboseLogging

Version

Methods

Append

AppendFromFile

AppendFromSb

Clear

FindMatch

FindSubstring

GetStrings

IntAt

SaveToFile

Sort

SplitAndAppend

StringAt

StringAtSb

ToSb

WordFollowing