Skip to main content

PdfDocumentModel

Struct PdfDocumentModel 

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

PDF 文档的引擎无关语义表示。

包含元数据与按页组织的语义内容块。

Implementations§

Source§

impl PdfDocumentModel

Source

pub const fn new(metadata: PdfMetadata, pages: Vec<PdfPageModel>) -> Self

创建文档模型。

Source

pub const fn metadata(&self) -> &PdfMetadata

返回文档元数据。

Source

pub fn pages(&self) -> &[PdfPageModel]

返回页面列表。

Source

pub fn page_count(&self) -> usize

返回页面数量。

Source

pub fn is_empty(&self) -> bool

判断文档是否不含页面。

Source

pub fn iter(&self) -> impl Iterator<Item = &PdfPageModel>

返回页面迭代器。

Source

pub fn total_blocks(&self) -> usize

返回所有页面中内容块的总数。

§Examples
use easypdf_core::{PdfBlock, PdfDocumentModel, PdfPageModel, SourceLocation};
use easypdf_core::{PageIndex, PdfMetadata};

let loc = SourceLocation::new(PageIndex::new(0), 1.0);
let page = PdfPageModel::new(PageIndex::new(0))
    .with_block(PdfBlock::paragraph("A", loc))
    .with_block(PdfBlock::paragraph("B", loc));
let doc = PdfDocumentModel::new(PdfMetadata::default(), vec![page]);
assert_eq!(doc.total_blocks(), 2);
Source

pub fn iter_all_blocks(&self) -> impl Iterator<Item = (usize, &PdfBlock)>

扁平遍历所有页面的内容块,附带一基页码。

返回迭代器产出 (page_number, &PdfBlock) 元组。

§Examples
use easypdf_core::{PdfBlock, PdfDocumentModel, PdfPageModel, SourceLocation};
use easypdf_core::{PageIndex, PdfMetadata};

let loc = SourceLocation::new(PageIndex::new(0), 1.0);
let page = PdfPageModel::new(PageIndex::new(0))
    .with_block(PdfBlock::paragraph("Hello", loc));
let doc = PdfDocumentModel::new(PdfMetadata::default(), vec![page]);
let blocks: Vec<_> = doc.iter_all_blocks().collect();
assert_eq!(blocks.len(), 1);
assert_eq!(blocks[0].0, 1); // 1-based page number
Source

pub fn block_count_by_type(&self) -> HashMap<PdfBlockType, usize>

统计每种 PdfBlockType 的出现次数。

§Examples
use easypdf_core::{PdfBlock, PdfBlockType, PdfDocumentModel, PdfPageModel, SourceLocation};
use easypdf_core::{PageIndex, PdfMetadata};

let loc = SourceLocation::new(PageIndex::new(0), 1.0);
let page = PdfPageModel::new(PageIndex::new(0))
    .with_block(PdfBlock::heading(1, "Title", loc))
    .with_block(PdfBlock::paragraph("Body", loc));
let doc = PdfDocumentModel::new(PdfMetadata::default(), vec![page]);
let counts = doc.block_count_by_type();
assert_eq!(counts[&PdfBlockType::Heading], 1);
assert_eq!(counts[&PdfBlockType::Paragraph], 1);

Trait Implementations§

Source§

impl Clone for PdfDocumentModel

Source§

fn clone(&self) -> PdfDocumentModel

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 PdfDocumentModel

Source§

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

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

impl Default for PdfDocumentModel

Source§

fn default() -> PdfDocumentModel

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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