Struct Image 

pub struct Image { /* private fields */ }

An embedded image.

See [MS-ONE] 2.2.24.

Implementations

impl Image

pub fn read(&self) -> Option<Box<dyn Read>>

A [Read] over the image’s binary data.

Bytes are pulled lazily from the underlying crate::fs::FileSource. Returns None if the image data hasn’t been uploaded yet. Call data_status before reading to distinguish invalid data from a valid zero-byte payload.

pub fn size(&self) -> Option<u64>

The size of the image in bytes, or None if not yet uploaded.

pub fn data_status(&self) -> FileDataStatus

Availability of the image’s binary data.

Consumers should render a broken-content indicator for FileDataStatus::Invalid instead of treating it as a valid zero-byte image.

pub fn extension(&self) -> Option<&str>

The image’s file extension.

pub fn layout_max_width(&self) -> Option<f32>

The maximum width to display the image in half-inch increments.

See [MS-ONE] 2.3.21.

pub fn layout_max_height(&self) -> Option<f32>

The maximum height to display the image in half-inch increments.

See [MS-ONE] 2.3.23.

pub fn alt_text(&self) -> Option<&str>

Alternative text for the image.

Usually this seems to be the result of OneNote’s OCR processing.

See [MS-ONE] 2.2.79.

pub fn layout_alignment_in_parent(&self) -> Option<LayoutAlignment>

The image’s alignment relative to the containing outline element (if present).

See [MS-ONE] 2.3.27.

pub fn layout_alignment_self(&self) -> Option<LayoutAlignment>

The image’s alignment.

See [MS-ONE] 2.3.33.

pub fn image_filename(&self) -> Option<&str>

The image’s original file name.

See [MS-ONE] 2.2.75.

Untrusted input

This string is metadata from the parsed OneNote file and is fully controlled by whoever authored that file. It may contain path separators (/, \), parent-directory components (..), NUL bytes, Windows reserved device names (CON, COM1, …), extremely long sequences, or arbitrary Unicode. Consumers that use this value as part of a write path on disk must sanitise it themselves — typically with sanitize_filename or equivalent. Passing it unmodified to std::fs::File::create is a path-traversal / device-handle vulnerability.

pub fn displayed_page_number(&self) -> Option<u32>

The page number to display if the image file contains multiple pages (e.g. XPS, PDF).

See [MS-ONE] 2.3.95.

pub fn text(&self) -> Option<&str>

The text for the image.

pub fn text_language_code(&self) -> Option<u32>

The text’s language code (MS-LCID)

pub fn picture_width(&self) -> Option<f32>

The image’s width in half-inch increments.

See [MS-ONE] 2.3.100.

pub fn picture_height(&self) -> Option<f32>

The image’s height in half-inch increments.

See [MS-ONE] 2.3.101.

pub fn hyperlink_url(&self) -> Option<&str>

A hyperlink associated with this image.

pub fn offset_horizontal(&self) -> Option<f32>

The horizontal offset from the page origin in half-inch increments.

See [MS-ONE] 2.3.18.

pub fn offset_vertical(&self) -> Option<f32>

The vertical offset from the page origin in half-inch increments.

See [MS-ONE] 2.3.19.

pub fn is_background(&self) -> bool

Whether the image is a background image.

See [MS-ONE] 2.3.61.

pub fn note_tags(&self) -> &[NoteTag]

Note tags for this image.

pub fn embeds(&self) -> &[IFrame]

Embedded iframes for this image.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl PartialEq for Image

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Image