ImageLoader

Struct ImageLoader 

Source
pub struct ImageLoader {
    base_dir: Option<PathBuf>,
    cache: HashMap<String, ImageData>,
    allow_remote: bool,
}
Expand description

Manages loading and caching of images for a document.

Provides automatic path resolution for relative paths and handles both local filesystem and remote HTTP(S) image loading.

Fields§

§base_dir: Option<PathBuf>

Base directory for resolving relative paths

§cache: HashMap<String, ImageData>

Cache of loaded images to avoid redownloading

§allow_remote: bool

Whether to enable remote image downloading

Implementations§

Source§

impl ImageLoader

Source

pub fn new(document_path: Option<&Path>) -> Self

Create a new image loader for a document at the specified path.

The base directory is extracted from the document path and used to resolve relative image references.

§Arguments
  • document_path - Path to the markdown document (optional)
§Example
use markdown2pdf::images::ImageLoader;
use std::path::Path;

let loader = ImageLoader::new(Some(Path::new("./docs/document.md")));
// Images will be resolved relative to ./docs/
Source

pub fn set_allow_remote(&mut self, allow: bool)

Enable or disable remote image downloading.

§Example
use markdown2pdf::images::ImageLoader;
let mut loader = ImageLoader::new(None);
loader.set_allow_remote(false);
// Will not download images from URLs
Source

pub fn resolve_path(&self, url_or_path: &str) -> Result<String, ImageError>

Resolve an image path relative to the document location.

For absolute URLs (http/https), returns the URL as-is. For relative paths, resolves them relative to the document directory.

§Arguments
  • url_or_path - Image URL or relative path
§Returns

Either an absolute path string for local images or a full URL for remote images

§Example
use markdown2pdf::images::ImageLoader;
use std::path::Path;

let loader = ImageLoader::new(Some(Path::new("./docs/document.md")));
// Relative path gets resolved
// loader.resolve_path("images/photo.jpg") -> "/full/path/to/docs/images/photo.jpg"
// HTTP URL stays as-is
// loader.resolve_path("https://example.com/image.jpg") -> "https://example.com/image.jpg"
Source

pub fn load(&mut self, url_or_path: &str) -> Result<ImageData, ImageError>

Load an image from a URL or path.

Attempts to load from cache first, then from local filesystem or remote URL. Returns image data along with format information.

§Arguments
  • url_or_path - Image URL or relative path
§Errors

Returns ImageError if loading fails or image format is unsupported.

Source

fn load_local(&self, path: &str) -> Result<Vec<u8>, ImageError>

Load an image from the local filesystem.

§Errors

Returns ImageError::LoadError if the file cannot be read.

Source

fn load_remote(&self, url: &str) -> Result<Vec<u8>, ImageError>

Download an image from a remote URL.

Requires the fetch feature to be enabled.

§Errors

Returns ImageError::DownloadError if the download fails.

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
§

impl<T> Finish for T

§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

§

fn to_owned_table(&self) -> U

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more