Struct Name 

pub struct Name(/* private fields */);

A PDF name, holding its decoded bytes without the leading /.

Names are almost always ASCII identifiers, but the syntax permits any byte through #xx escapes, so the storage is bytes rather than a String. Specification-defined keys are 'static and cost nothing to name; parsed ones own their bytes.

use pdfrum_object::{Name, names};

let n = Name::new(b"Length".to_vec());
assert_eq!(n.as_str(), Some("Length"));
assert_eq!(&n, names::LENGTH);

// `#xx` escapes are resolved on the way in, so spellings unify.
assert_eq!(Name::decode(b"A#42"), Name::new(b"AB".to_vec()));

Implementations

impl Name

pub fn new(bytes: impl Into<Vec<u8>>) -> Self

A name from bytes that are already decoded.

pub const fn from_static(bytes: &'static [u8]) -> Self

A name from a 'static spelling, without copying. bytes must already be decoded, which every specification-defined key is.

pub fn decode(raw: &[u8]) -> Self

A name from the raw token following / in a file, resolving #xx escapes — see name_decode.

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

The decoded bytes.

pub fn as_str(&self) -> Option<&str>

The name as UTF-8, or None for the rare name that is not.

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

The name read as a text string, for dumps that print names as text.

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

The file syntax for this name, including the leading / — see name_encode.

Trait Implementations

impl AsRef<[u8]> for Name

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

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

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Prints the name the way a file spells it (/Length), so an object dump reads like the PDF it came from rather than like a byte array.

impl Eq for Name

impl From<&[u8]> for Name

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Name

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Name> for Object

fn from(v: Name) -> Self

Converts to this type from the input type.

impl Hash for Name

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 Ord for Name

fn cmp(&self, other: &Name) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Name

fn eq(&self, other: &Name) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Name

fn partial_cmp(&self, other: &Name) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Name