Struct PdfString 

pub struct PdfString { /* private fields */ }

A PDF string with encoding-aware conversion.

Stores the raw bytes as they appear in the PDF file. The encoding is detected from the content: if the bytes start with 0xFE 0xFF (BOM), the string is UTF-16BE; otherwise it is PDFDocEncoding.

Implementations

impl PdfString

pub fn from_bytes(bytes: Vec<u8>) -> Self

Create a PdfString from raw bytes (as parsed from the PDF).

pub fn from_unicode(s: &str) -> Self

Encode a UTF-8 string as a PDF string.

Uses PDFDocEncoding if every character is representable; otherwise uses UTF-16BE with a 0xFE 0xFF byte-order mark. This matches the logic of PDF_EncodeText() in PDFium upstream.

Examples

let ascii = PdfString::from_unicode("hello");
assert_eq!(ascii.encoding(), PdfStringEncoding::PdfDocEncoding);

let unicode = PdfString::from_unicode("日本語");
assert_eq!(unicode.encoding(), PdfStringEncoding::Utf16Be);

pub fn as_bytes(&self) -> &[u8]

Raw bytes (for binary operations, stream /Length, etc.).

pub fn encoding(&self) -> PdfStringEncoding

Detect encoding from the byte-order mark.

• 0xFE 0xFF → PdfStringEncoding::Utf16Be
• 0xEF 0xBB 0xBF → PdfStringEncoding::Utf8Bom
• Otherwise → PdfStringEncoding::PdfDocEncoding

pub fn to_string_lossy(&self) -> String

Decode to a Rust String (UTF-8), handling all PDF string encodings.

• UTF-16BE: decoded with surrogate-pair support; invalid pairs → U+FFFD.
• UTF-8 BOM: decoded as UTF-8 after stripping the BOM.
• PDFDocEncoding: each byte mapped to Unicode per ISO 32000-2 Annex D.

ISO 2022 language-tag escape sequences (U+001B…U+001B) present in UTF-16BE and UTF-8 BOM strings are stripped, matching the behaviour of StripLanguageCodes() / PDF_DecodeText() in PDFium upstream.

pub fn is_empty(&self) -> bool

Returns true if the string has no bytes.

pub fn len(&self) -> usize

Returns the length of the raw byte representation.

pub fn unicode_data(&self) -> String

👎Deprecated:

use to_string_lossy() instead

Decode to a Rust String (UTF-8), handling both PDF encodings.

Deprecated; use to_string_lossy instead.

pub fn get_unicode_data(&self) -> String

Upstream-aligned alias for to_string_lossy.

Corresponds to ByteString::GetUnicodeData() in PDFium upstream.

pub fn get_raw_string(&self) -> &[u8]

Upstream-aligned alias for as_bytes.

Corresponds to ByteString::GetRawString() in PDFium upstream.

Trait Implementations

impl Clone for PdfString

fn clone(&self) -> PdfString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfString

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

Formats the value using the given formatter.

impl Display for PdfString

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

Formats the value using the given formatter.

impl Hash for PdfString

fn hash<__H: Hasher>(&self, state: &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 PartialEq for PdfString

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

impl StructuralPartialEq for PdfString