Struct PdfString 

pub struct PdfString { /* private fields */ }

A PDF string object: raw bytes plus the syntax they were written in.

use pdfrum_object::PdfString;

let s = PdfString::literal(b"A simple test");
assert_eq!(s.as_text(), "A simple test");
assert_eq!(s.syntax(), pdfrum_object::StringSyntax::Literal);

// A UTF-16BE byte-order mark selects the Unicode reading.
let unicode = PdfString::hex(b"\xFE\xFF\x03\x30\x03\x31");
assert_eq!(unicode.as_text(), "\u{0330}\u{0331}");
assert_eq!(unicode.syntax(), pdfrum_object::StringSyntax::Hex);

Implementations

impl PdfString

pub fn literal(bytes: impl AsRef<[u8]>) -> Self

A string spelled (like this).

pub fn hex(bytes: impl AsRef<[u8]>) -> Self

A string spelled <6C696B652074686973>.

pub fn new(bytes: impl AsRef<[u8]>, syntax: StringSyntax) -> Self

A string with an explicit syntax.

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

The string’s bytes, escapes already resolved.

pub fn syntax(&self) -> StringSyntax

Whether the source syntax was <hex> rather than (literal).

pub fn is_hex(&self) -> bool

true when PdfString::syntax is StringSyntax::Hex.

pub fn as_text(&self) -> Cow<'_, str>

Interpret the bytes as text — see decode_text.

pub fn encode(&self) -> Vec<u8>

Re-spell the string in its original syntax, ready to write into a file.

Trait Implementations

impl AsRef<[u8]> for PdfString

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

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

Prints the string the way a file spells it, so an object dump reads like the PDF it came from rather than like a byte array.

impl Eq for PdfString

impl From<PdfString> for Object

fn from(v: PdfString) -> Self

Converts to this type from the input type.

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PdfString