Skip to main content

NameTree

Struct NameTree 

Source
pub struct NameTree<V> { /* private fields */ }
Expand description

A parsed name tree mapping string keys to values of type V.

Implementations§

Source§

impl<V> NameTree<V>

Source

pub fn parse<S: PdfSource, F>( root: &Object, store: &ObjectStore<S>, convert: F, ) -> DocResult<Self>
where F: Fn(&Object) -> DocResult<V>,

Parse a name tree starting from the given root object.

The convert function transforms each value Object into a V. Traversal is fully iterative using an explicit stack.

Source

pub fn count(&self) -> usize

Return the number of entries in this name tree.

Corresponds to CPDF_NameTree::GetCount() in PDFium.

Source

pub fn get_count(&self) -> usize

Upstream-aligned alias for count().

Corresponds to CPDF_NameTree::GetCount() in PDFium.

Source

pub fn get(&self, name: &str) -> Option<&V>

Look up a value by its string key.

Source

pub fn entries(&self) -> &[(String, V)]

Return all entries as a slice of (String, V) pairs.

Source

pub fn add(&mut self, name: String, value: V) -> DocResult<()>

Add an entry to the name tree, maintaining sorted order.

If an entry with the same name already exists it is replaced. The in-memory tree is updated; to persist the change to a PDF file use rpdfium-edit.

Source

pub fn delete_by_index(&mut self, index: usize) -> DocResult<()>

Delete an entry by its index.

Returns DocError::InvalidIndex if index is out of range.

Source

pub fn delete_by_name(&mut self, name: &str) -> DocResult<()>

Delete an entry by its name key.

Returns DocError::NotFound if no entry with the given name exists.

Trait Implementations§

Source§

impl<V: Clone> Clone for NameTree<V>

Source§

fn clone(&self) -> NameTree<V>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<V: Debug> Debug for NameTree<V>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V> Freeze for NameTree<V>

§

impl<V> RefUnwindSafe for NameTree<V>
where V: RefUnwindSafe,

§

impl<V> Send for NameTree<V>
where V: Send,

§

impl<V> Sync for NameTree<V>
where V: Sync,

§

impl<V> Unpin for NameTree<V>
where V: Unpin,

§

impl<V> UnsafeUnpin for NameTree<V>

§

impl<V> UnwindSafe for NameTree<V>
where V: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more