Skip to main content

XfdfDocument

Struct XfdfDocument 

Source
pub struct XfdfDocument {
    pub xmlns: Option<String>,
    pub fields: Vec<XfdfField>,
    pub annotations: Vec<Annotation>,
    pub metadata: HashMap<String, String>,
}
Expand description

XFDF 文档 一份完整的 XFDF 文档。

它里面通常会包含:

  • 文档级元数据
  • 表单字段
  • 注释列表

Fields§

§xmlns: Option<String>

XML 命名空间

§fields: Vec<XfdfField>

表单字段

§annotations: Vec<Annotation>

注释列表

§metadata: HashMap<String, String>

元数据

Implementations§

Source§

impl XfdfDocument

Source

pub fn parse(xml_str: &str) -> Result<Self>

解析 XFDF/XML 字符串,得到统一的文档对象。

§示例
use pdfxml::XfdfDocument;

let xml = r#"<?xml version="1.0" encoding="UTF-8" ?>
<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">
  <annots>
    <text page="0" rect="100,700,250,730">Hello</text>
  </annots>
</xfdf>"#;

let doc = XfdfDocument::parse(xml)?;
assert_eq!(doc.annotations.len(), 1);
Source

pub fn get_annotations_for_page(&self, page: usize) -> Vec<&Annotation>

获取指定页面上的所有注释。

§示例
use pdfxml::XfdfDocument;

let doc = XfdfDocument::parse(r#"<?xml version="1.0" encoding="UTF-8" ?>
<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">
  <annots>
    <text page="0" rect="100,700,250,730">Hello</text>
    <text page="1" rect="100,650,250,680">World</text>
  </annots>
</xfdf>"#)?;

assert_eq!(doc.get_annotations_for_page(0).len(), 1);
Source

pub fn total_pages(&self) -> usize

返回文档总页数。

如果没有任何注释,默认返回 1

§示例
use pdfxml::XfdfDocument;

let doc = XfdfDocument::parse(r#"<?xml version="1.0" encoding="UTF-8" ?>
<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">
  <annots>
    <text page="2" rect="100,700,250,730">Hello</text>
  </annots>
</xfdf>"#)?;

assert_eq!(doc.total_pages(), 3);
Source

pub fn to_xfdf_string(&self) -> Result<String>

把当前文档重新序列化成 XFDF 字符串。

§示例
use pdfxml::XfdfDocument;

let doc = XfdfDocument::parse(r#"<?xml version="1.0" encoding="UTF-8" ?>
<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">
  <annots>
    <text page="0" rect="100,700,250,730">Hello</text>
  </annots>
</xfdf>"#)?;

let xml = doc.to_xfdf_string()?;
assert!(xml.contains("<xfdf"));

Trait Implementations§

Source§

impl Clone for XfdfDocument

Source§

fn clone(&self) -> XfdfDocument

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 Debug for XfdfDocument

Source§

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

Formats the value using the given formatter. 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<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.