Skip to main content

ContentEditor

Struct ContentEditor 

Source
pub struct ContentEditor { /* private fields */ }
Expand description

Editor for PDF content stream operations.

Decodes a raw content stream into Vec<Operation>, allows mutation (remove, replace, insert), and encodes back to bytes.

Implementations§

Source§

impl ContentEditor

Source

pub fn from_stream(stream: &[u8]) -> Result<Self>

Decode a content stream from raw bytes.

Returns Err if the stream has pathological array nesting (depth > MAX_CONTENT_ARRAY_DEPTH) to avoid a stack overflow in lopdf’s recursive array parser. All callers handle Err gracefully (skip/continue).

Source

pub fn from_operations(operations: Vec<Operation>) -> Self

Create an editor from a pre-existing list of operations.

Source

pub fn new() -> Self

Create an empty editor.

Source

pub fn operations(&self) -> &[Operation]

Return a reference to the operations.

Source

pub fn operations_mut(&mut self) -> &mut Vec<Operation>

Return a mutable reference to the operations.

Source

pub fn len(&self) -> usize

Number of operations.

Source

pub fn is_empty(&self) -> bool

Whether the editor has no operations.

Source

pub fn remove_range(&mut self, range: Range<usize>)

Remove operations in the given range.

Source

pub fn replace_operation(&mut self, index: usize, ops: Vec<Operation>)

Replace the operation at index with one or more operations.

Source

pub fn insert_operations(&mut self, at: usize, ops: Vec<Operation>)

Insert operations at the given position.

Source

pub fn push(&mut self, op: Operation)

Append operations at the end.

Source

pub fn retain<F>(&mut self, f: F)
where F: FnMut(&Operation) -> bool,

Remove all operations matching a predicate.

Source

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

Encode operations back to content stream bytes.

Uses custom encoding for inline images (BI/ID/EI), because lopdf’s Content::encode() incorrectly serializes them as regular stream objects.

Source

pub fn encode_compressed(&self) -> Result<Vec<u8>>

Encode and compress with flate.

Source

pub fn track_state(&self) -> GraphicsStateTracker

Build a GraphicsStateTracker that walks all operations and records the graphics state at each operation index.

Trait Implementations§

Source§

impl Clone for ContentEditor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContentEditor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ContentEditor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.