Struct Text 

pub struct Text { /* private fields */ }

In-memory representation of a decoded text file.

Stores the text contents along with encoding and format metadata. The encoding is preserved when re-encoding to maintain file compatibility.

Fields

• encoding - Character encoding detected or specified for the file
• format - File format detected from extension (for syntax highlighting)
• contents - Decoded text contents as a UTF-8 Rust string

Getters/Setters

All fields have public getters, mutable getters, and setters via the getset crate:

• encoding(), encoding_mut(), set_encoding()
• format(), format_mut(), set_format()
• contents(), contents_mut(), set_contents()

Example

use rpfm_lib::files::{Decodeable, text::Text, DecodeableExtraData};
use std::io::Cursor;

let data = b"Hello, World!";
let mut reader = Cursor::new(data);
let text = Text::decode(&mut reader, &None).unwrap();

assert_eq!(text.contents(), "Hello, World!");

Implementations

impl Text

pub fn encoding(&self) -> &Encoding

Character encoding of the file.

pub fn format(&self) -> &TextFormat

Detected file format based on extension.

pub fn contents(&self) -> &String

Decoded text contents.

impl Text

pub fn encoding_mut(&mut self) -> &mut Encoding

Character encoding of the file.

pub fn format_mut(&mut self) -> &mut TextFormat

Detected file format based on extension.

pub fn contents_mut(&mut self) -> &mut String

Decoded text contents.

impl Text

pub fn set_encoding(&mut self, val: Encoding) -> &mut Self

Character encoding of the file.

pub fn set_format(&mut self, val: TextFormat) -> &mut Self

Detected file format based on extension.

pub fn set_contents(&mut self, val: String) -> &mut Self

Decoded text contents.

impl Text

pub fn detect_encoding<R: ReadBytes>(data: &mut R) -> Result<Encoding>

Detects the character encoding of text data.

Examines the data stream to determine its encoding by checking for Byte Order Marks (BOMs) and attempting to decode as different encodings.

Detection Algorithm

1. UTF-8 BOM: Checks for 0xEF 0xBB 0xBF at the start
2. UTF-16 LE BOM: Checks for 0xFF 0xFE at the start
3. UTF-8 without BOM: Attempts to decode entire file as UTF-8
4. ISO-8859-1: Attempts to decode as ISO-8859-1

Arguments

• data - Reader positioned at the start of the text data

Returns

The detected Encoding, or an error if no supported encoding matches.

Errors

Returns RLibError::DecodingTextUnsupportedEncodingOrNotATextFile if:

• The data cannot be decoded as any supported encoding
• The file is not actually a text file

Side Effects

After detection, the reader is repositioned:

• After the BOM if one was found
• At the start if no BOM was found

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Decodeable for Text

fn decode<R: ReadBytes>( data: &mut R, extra_data: &Option<DecodeableExtraData<'_>>, ) -> Result<Self>

Decodes binary data into the implementing type.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Text

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for Text

fn encode<W: WriteBytes>( &mut self, buffer: &mut W, _extra_data: &Option<EncodeableExtraData<'_>>, ) -> Result<()>

Encodes the implementing type into binary data.

impl PartialEq for Text

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Text

impl StructuralPartialEq for Text