Skip to main content

OverlayBase

Struct OverlayBase 

Source
pub struct OverlayBase {
    pub prev: u64,
    pub kind: XrefStyle,
    pub size: u32,
    pub root: ObjRef,
    pub info: Option<ObjRef>,
    pub id: Option<Object>,
}
Expand description

The facts about a base document an update needs, read once from its trailer and its own newest cross-reference section: refuses an encrypted base or one missing /Root or a startxref to chain from.

Fields§

§prev: u64

Byte offset of the base’s own newest cross-reference section, named as the appended section’s /Prev.

§kind: XrefStyle

Style of that newest section, read from the section itself rather than the merged trailer (a hybrid base’s merged trailer carries /Type /XRef inherited from its /XRefStm, even though its newest section, per startxref, is the classic table).

§size: u32

The next free object number: the base’s declared /Size, raised to one past its highest addressed object number.

§root: ObjRef

The base’s catalog.

§info: Option<ObjRef>

The base’s document information dictionary, when present.

§id: Option<Object>

The base trailer’s /ID array, cloned.

Implementations§

Source§

impl OverlayBase

Source

pub fn from_document(doc: &Document) -> Result<OverlayBase>

Reads doc’s trailer and newest cross-reference section: the section’s offset and kind come from doc.xref().newest_section(), already recorded while core loaded the file, falling back to re-deriving them from startxref and parse_section_at when the document has none (a recovery-scan base refuses with Error::MissingStartxref on this fallback path). Refuses any encrypted doc outright, wider than crate::importer::Importer::new’s own locked-only refusal: appending onto an already-encrypted base is a feature this crate does not yet implement, so every encrypted base is refused here for now, password-opened or not.

Trait Implementations§

Source§

impl Clone for OverlayBase

Source§

fn clone(&self) -> OverlayBase

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 OverlayBase

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> 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 = !

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.