PdfArray

Struct PdfArray 

Source
pub struct PdfArray(pub Vec<PdfObject>);
Expand description

PDF Array object - Ordered collection of PDF objects.

Arrays can contain any PDF object type, including other arrays and dictionaries. They are written in PDF syntax as [item1 item2 ... itemN].

§Common Uses

  • Rectangle specifications: [llx lly urx ury]
  • Color values: [r g b]
  • Matrix transformations: [a b c d e f]
  • Resource lists

§Example

use oxidize_pdf::parser::objects::{PdfArray, PdfObject};

// Create a MediaBox array [0 0 612 792]
let mut media_box = PdfArray::new();
media_box.push(PdfObject::Integer(0));
media_box.push(PdfObject::Integer(0));
media_box.push(PdfObject::Integer(612));
media_box.push(PdfObject::Integer(792));

assert_eq!(media_box.len(), 4);

Tuple Fields§

§0: Vec<PdfObject>

Implementations§

Source§

impl PdfArray

Source

pub fn new() -> Self

Create a new empty array

Source

pub fn len(&self) -> usize

Get array length

Source

pub fn is_empty(&self) -> bool

Check if array is empty

Source

pub fn get(&self, index: usize) -> Option<&PdfObject>

Get element at index.

§Arguments
  • index - Zero-based index
§Returns

Reference to the element if index is valid, None otherwise.

§Example
use oxidize_pdf::parser::objects::{PdfArray, PdfObject};

let mut array = PdfArray::new();
array.push(PdfObject::Integer(10));
array.push(PdfObject::Integer(20));

assert_eq!(array.get(0).and_then(|o| o.as_integer()), Some(10));
assert_eq!(array.get(1).and_then(|o| o.as_integer()), Some(20));
assert!(array.get(2).is_none());
Source

pub fn push(&mut self, obj: PdfObject)

Push an element

Trait Implementations§

Source§

impl Clone for PdfArray

Source§

fn clone(&self) -> PdfArray

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 PdfArray

Source§

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

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

impl Default for PdfArray

Source§

fn default() -> Self

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

impl PartialEq for PdfArray

Source§

fn eq(&self, other: &PdfArray) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PdfArray

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