Struct AnnotObjectCtxMut 

pub struct AnnotObjectCtxMut<'doc> { /* private fields */ }

Mutable context for accessing AP-stream objects on a single annotation.

Obtained via EditDocument::annot_objects_mut().

Example

let mut ctx = doc.annot_objects_mut(annot_id);
ctx.append_object(obj).unwrap();
ctx.remove_object(0).unwrap();

Implementations

impl<'doc> AnnotObjectCtxMut<'doc>

pub fn get_object(&self, index: usize) -> Option<&PageObject>

Returns a reference to the AP-stream object at index.

ADR-019 T2 alias for FPDFAnnot_GetObject.

pub fn get_object_count(&self) -> usize

Returns the number of AP-stream objects for this annotation.

ADR-019 T2 alias for FPDFAnnot_GetObjectCount.

pub fn remove_object(&mut self, index: usize) -> Result<(), EditError>

Remove the AP-stream object at index from this annotation.

ADR-019 T2 alias for FPDFAnnot_RemoveObject. Namespaced here to avoid collision with the FPDFPage_RemoveObject alias on EditDocument.

See also PageObjectCtxMut::remove_object() for the page side.

pub fn append_object(&mut self, object: PageObject) -> Result<(), EditError>

Append a page object to this annotation’s AP-stream object list.

ADR-019 T2 alias for FPDFAnnot_AppendObject.

pub fn get_object_mut(&mut self, index: usize) -> Option<&mut PageObject>

Returns a mutable reference to the AP-stream object at index.

Returns None if index is out of bounds.

There is no upstream FPDFAnnot_GetObjectMut; mutable access is Rust-specific. This is the canonical way to modify an annotation’s AP-stream objects in-place.